fix(ci): Broaden check-env-docs.sh so it scans every crate that reads environment variables
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 72/100
Research direction
Start with scripts/check-env-docs.sh and read docs/threat-model.md for the security constraints. Run just check-env-docs to see the current baseline, then inspect environment variable reads under crates/*/src/**/*.rs and how tests are excluded. Done when the expanded scan checks the requested crates, test-only variables are allowlisted, documentation gaps are fixed or listed in the PR, and just check-env-docs passes.
Written by the indexing model from the issue text.
Description
Description
scripts/check-env-docs.sh only greps bin/server/src/main.rs and crates/store/src/config.rs, so variables read elsewhere (HORIZON_*, ARGON2_*, CLOUDINARY_*, OCTO_*, TRUSTED_PROXY_CIDRS) are never checked.
Requirements and context
- Where:
scripts/check-env-docs.sh - Security: Follow
docs/threat-model.md; no secrets, tokens or personal data in code, logs, tests or commit messages. - Testing:
just fmt-check,just lintandjust testmust pass; add or update tests for the change. - Documentation: Update the nearest doc if behaviour changes; otherwise no doc change is needed.
Suggested execution
- Comment on this issue to claim it, then fork the repository and branch from
main. - Branch name:
git checkout -b fix/check-env-docs-scan-scope
Implement changes
- Also scan
crates/*/src/**/*.rs(excluding tests) with the sameenv::var("NAME")pattern. - Add a small allowlist for test-only variables.
- Fix any documentation gaps the stricter scan finds, or list them in the PR.
Test and commit
- Run
just check-env-docsbefore and after; the PR must leave it green. - Run
just fmt,just lintandjust testlocally before pushing (seeCONTRIBUTING.md). - Commit with a conventional message and keep the change small and focused.
Example commit message
fix(ci): scan all crates for undocumented env vars
Guidelines
- Open the PR against
mainand link it withCloses #<this issue>. - Keep the diff focused on this issue; no unrelated refactors or formatting churn.
- One line per comment, no bloated code; follow patterns already used in the crate.
- Never commit secrets,
.envfiles or real keys; use public test vectors only. - CI (fmt, clippy
-D warnings, tests) must be green before requesting review. - Ask in the issue thread if anything is unclear before starting.
- Dominant language
- Rust
- Stars
- 0
- Forks
- 91
- Avg merge
- 5h 23m
- Merged PRs (30d)
- 4
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Octo-Protocol-org/Octo-Protocol
-
area/integration area/testing enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area/integration area/testing enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area/integration area/testing enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area/integration area/testing enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
area/integration area/testing enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Octo-Protocol-org/Octo-Protocol#701 · 1 comment ·
All issues in Octo-Protocol-org/Octo-Protocol
Similar issues
-
needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
pbakaus/impeccable#1601 ·
Maintainers usually reply within 1 day
-
RDF/XML writer: a blank node in two lists is left out of the secondPossibly taken @mrnolte claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
phillord/horned-owl#368 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
mongodb/kingfisher#588 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
bug rust
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 2 days