fix(ci): Broaden check-env-docs.sh so it scans every crate that reads environment variables

Open
#674 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
72/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
rust, shell
Domain
ci-cd, security

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

area/integration bug good first issue help wanted

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 lint and just test must 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 same env::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-docs before and after; the PR must leave it green.
  • Run just fmt, just lint and just test locally before pushing (see CONTRIBUTING.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 main and link it with Closes #<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, .env files 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

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Octo-Protocol-org/Octo-Protocol

All issues in Octo-Protocol-org/Octo-Protocol

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.