Document environment variables and drop unused GH_TOKEN wiring#25
Open
askov wants to merge 1 commit intosolana-developers:mainfrom
Open
Document environment variables and drop unused GH_TOKEN wiring#25askov wants to merge 1 commit intosolana-developers:mainfrom
askov wants to merge 1 commit intosolana-developers:mainfrom
Conversation
Adds a single env-vars reference table to the README (required-when, sensitivity, purpose) plus a .env.example template so local setup no longer depends on reading scattered code. Drops the unreferenced GH_TOKEN from app.yaml and the deploy workflow — only GH_TOKENS (plural) is consumed by githubClient.js.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
.env.exampleas a committed template — placeholder values only, real.envstays gitignored.GH_TOKEN(singular) fromapp.yamland.github/workflows/deploy.yaml. OnlyGH_TOKENS(plural, comma-separated) is read bysrc/clients/githubClient.js.Why
Env-var docs in the README drifted from the code: the old instructions required
PROJECT_IDlocally (actually bypassed whenPOSTGRES_STRINGis set), referenced a singularGH_TOKENthe code never reads, and gave no guidance on which values are secrets. This PR realigns docs with runtime behaviour and makes the sensitivity of each variable explicit.Test plan
GH_TOKEN(singular) is not referenced anywhere insrc/—grep -rn "GH_TOKEN\b" src/should return nothing.GH_TOKENSsecret is still wired throughapp.yamland the deploy workflow.GH_TOKENS)..env.exampleto run the app locally against Cloud SQL Auth Proxy.