Skip to content

Keep the Tool-Fixed Env Exemption Out of a Secrets Directory - #3508

Merged
ptr727 merged 2 commits into
developfrom
clarify-env-exemption
Oct 26, 2026
Merged

ptr727 merged 2 commits into
developfrom
clarify-env-exemption

Conversation

@ptr727

@ptr727 ptr727 commented Oct 26, 2026

Copy link
Copy Markdown
Owner

Summary

Answers the headline of Copilot's round on promotion #3507, "Clarify the .env* exemption in CODESTYLE.md so it does not contradict the .secrets/ naming requirements."

CODESTYLE.md "Script and Utility File Names" exempts an env file a tool reads by a fixed name, such as .env. GOVERNANCE.md "Repo-Scoped Secrets" rules out a bare .env as the shared env file in .secrets/. The two never applied to the same file, but the exemption did not say so. It now says an env or secret file in a .secrets/ directory is never tool-fixed, since the repository configures the path it is read by. The next sentence names the exemption rather than a pronoun that would have attached to that file.

The secrets.stems check already behaves this way: it flags a bare .env inside .secrets/ and skips a dot-leading name outside one.

Refs #3503

Verification

  • The prose gate passes, sentence-length included.
  • Two local strict passes ran. The first raised two wording findings, both fixed in 2d6cdbee. The second found nothing and is recorded at the head.

🤖 Generated with Claude Code

ptr727 and others added 2 commits October 26, 2026 10:44
The exemption for an env file a tool reads by a fixed name read as if
it could cover a bare `.env` inside `.secrets/`, which GOVERNANCE.md
"Repo-Scoped Secrets" rules out. A file there is read by a configured
path, so the exemption now says it never reaches one.

Refs #3503

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The sentence now names an env or secret file, so it says nothing about
the directory's own .gitignore, and the next sentence names the
exemption rather than a pronoun that read as the file.

Refs #3503

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings October 26, 2026 17:47
@ptr727

ptr727 commented Oct 26, 2026

Copy link
Copy Markdown
Owner Author

A recorded local strict-review pass covers head 2d6cdbee941e5d46320f28802149262107aad4aa, the content this pull request carries at that commit against develop, and it recorded 0 findings.

@coderabbitai

coderabbitai Bot commented Oct 26, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The clarification is focused, consistent with existing repository rules, and has no unresolved review findings.

No open issues 🎉

What changed in this PR

This pull request clarifies that tool-fixed environment filenames, such as .env, are exempt only outside .secrets/ directories, aligning CODESTYLE.md with the repository’s secrets naming rules.

Changes:

  • Excludes environment and secret files in .secrets/ from the tool-fixed-name exemption.
  • Makes the exemption’s scope explicit while preserving platform-defined filename exceptions.
File Description
CODESTYLE.md Clarifies the scope of the externally fixed environment and secret filename exemption.

Review effort: Lite

@codecov

codecov Bot commented Oct 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.11%. Comparing base (9890e4a) to head (2d6cdbe).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3508   +/-   ##
========================================
  Coverage    81.11%   81.11%           
========================================
  Files           26       26           
  Lines         8914     8914           
========================================
  Hits          7231     7231           
  Misses        1683     1683           
Flag Coverage Δ
python-3.13 81.11% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ptr727
ptr727 merged commit d65fb3b into develop Oct 26, 2026
14 checks passed
@ptr727
ptr727 deleted the clarify-env-exemption branch October 26, 2026 18:19
ptr727 added a commit that referenced this pull request Oct 26, 2026
## Summary

Promotes the pull requests merged into develop since release 2.0.1195.

- [#3506](#3506):
`CODESTYLE.md` "Script and Utility File Names" now states one naming
convention for every env and secret file a repository names, tracked or
host-side. Fields are joined by `_`. A host field is a short name in DNS
label form, never a fully qualified name. The name carries no dot but
its extension. The `secrets.stems` check reads that grammar and now also
reaches tracked `.env` files outside `.secrets/`. `AUDIT.md`,
`GOVERNANCE.md` "Repo-Scoped Secrets", and the spec catalog follow.
- [#3508](#3508): answers
this promotion's first Copilot headline. `CODESTYLE.md`'s tool-fixed env
exemption now says an env or secret file in a `.secrets/` directory is
never tool-fixed, so it no longer reads as contradicting
`GOVERNANCE.md`'s rule against a bare `.env` there.

Closes #3503

## Constituent coverage

Each change this promotion carries had coverage on its own pull request
into develop:

| Pull request | Merged head | Coverage |
| --- | --- | --- |
| [#3506](#3506) |
`5753c6da` | attested local pass at the merged head, base `develop`, and
a Copilot round on an earlier head whose two findings were fixed and
resolved |
| [#3508](#3508) |
`2d6cdbee` | attested local pass at the merged head, base `develop`, and
a Copilot table on the merged head naming exactly its 1 changed file,
approval recommended, no findings |

🤖 Generated with [Claude Code](https://claude.com/claude-code)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants