Best Practices for Describing Keys? #30
-
It's easy to lose track of the purpose of keys, and it's easy to keep around keys that are no longer needed. To combat that, our current credentials approach stores a descriptive comment alongside each secret. This appears not to be possible in EnvKey; I couldn't even see a way to add text like this as a commit message. What do other EnvKey users do to solve these problems? Where to document each key, and how to ensure it stays up to date? Does EnvKey have a feature like this planned? |
Beta Was this translation helpful? Give feedback.
Replies: 2 comments 4 replies
-
Good question @bmulholland. A per-variable notes/comment feature is definitely on the roadmap and we have some groundwork laid for it. As with just about everything in EnvKey, including variable names, we want these notes to be end-to-end encrypted, so it is a bit more complex than it might sound. Certainly still doable though! While not particularly elegant, I suppose in the meantime you could add a |
Beta Was this translation helpful? Give feedback.
-
A vaguely related possible feature request here could be variable grouping / scoping - even if that's just a presentational nicety on top of the desktop UI. I'm thinking for example a group called |
Beta Was this translation helpful? Give feedback.
Good question @bmulholland. A per-variable notes/comment feature is definitely on the roadmap and we have some groundwork laid for it. As with just about everything in EnvKey, including variable names, we want these notes to be end-to-end encrypted, so it is a bit more complex than it might sound. Certainly still doable though!
While not particularly elegant, I suppose in the meantime you could add a
VARIABLE_COMMENT
below eachVARIABLE
you want to document, or else keep a separate file for this purpose in source control.