chore: add .env.example template for service install#44
Merged
Conversation
Closes #42 The install-service.sh script instructs users to run `cp .env.example .env`, but the template file had never been committed. Add it with placeholder values so `npm run service:install` works out of the box. Real secrets remain ignored via the existing `.env` rule in .gitignore.
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
1 participant
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.examplefile at the repo root with placeholder values for every env var referenced fromsrc/(Discord, Linear, optional NPM/OpenAI/task-state).npm run service:install, which already instructs users to runcp .env.example .envbefore install.Why
scripts/install-service.shexits withError: .env file not found.and suggestscp .env.example .env, but the template had never been committed. New users hit the dead end reported in #42.Safety
.envis still ignored by.gitignore:28(.envrule unchanged).Test plan
.env.exampleis tracked while.envremains ignored (git check-ignoreverified).cp .env.example .env→ edit real tokens →npm run service:installproceeds past the config check.Closes #42