docs: document insecure config permissions error, suggest v0.4.0 - #25
Draft
krakenhavoc wants to merge 1 commit into
Draft
docs: document insecure config permissions error, suggest v0.4.0#25krakenhavoc wants to merge 1 commit into
krakenhavoc wants to merge 1 commit into
Conversation
Carries forward the gap from #23 (opened 2026-08-04, never merged). No PRs merged or opened in this repo in the past week.
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.
Weekly documentation audit — 2026-08-18
No PRs were opened or merged in this repo between 2026-08-11 and 2026-08-18. This audit carries forward the still-unapplied changes from #23, which remains open: PR #22 ("fix: refuse to load config file with insecure permissions"), merged 2026-08-05, changes
internal/config.Load()/Save()behavior — a config file with permissions broader than0600used to trigger a stderr warning and load anyway; it now returnsErrInsecurePermissionsand refuses to load or save (exit code 5, not enforced on Windows). This remains undocumented onmain: README's Configuration section says nothing about the refuse-to-load behavior, and CHANGELOG.md's[Unreleased]section was still empty.Documentation gap
README.md's Configuration section andCHANGELOG.md's[Unreleased]section didn't reflect #22's behavior change.Updates to existing documentation
README.md: added a Permissions note under Configuration describing the refuse-to-load behavior, the exit code, and thechmod 600fix.CHANGELOG.md: added an[Unreleased]/ Changed entry for the same, referencing fix: refuse to load config file with insecure permissions #22.New docs needed
None.
Suggested version bump
Latest tag is still
v0.3.0; v0.4.0 has not been tagged. This remains a breaking behavior change for anyone whose config permissions are broader than0600, so per this repo's pre-1.0 SemVer convention it should ship as v0.4.0 once these docs are merged.This PR supersedes #23 (same content, unmerged since 2026-08-04).