[Feature Request] Permit allowlisted unencrypted comments
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 23.1k
- Forks
- 1.1k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 9
Description
[Feature Request] Allow specific unencrypted comments
- Suppose I want to document something about an encrypted values file, such that a user can read it. For instance:
- Including a documentation link on how to decrypt and edit the file.
- Including a warning about changes to the file.
It would be nice to be able to do something like # unencrypted: MY COMMENT to permit these comments.
Contributor 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.
Research direction
The issue does not identify files, tests, or an entry point. Begin by locating how SOPS parses and preserves comments in encrypted values files, then determine the supported formats and validation needed for an allowlisted unencrypted-comment syntax; done means the requested comments remain readable while other content stays protected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- security
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100