Add descriptions to secrets #15018
Replies: 4 comments
-
Absolutely more context would be useful. GitHub wants me to only use expiring tokens. It would be great to put the URL to the token as part of the description of the secret, so that it's easy to regenerate them as needed. |
Beta Was this translation helpful? Give feedback.
-
Descriptions for secrets is needed. Also, it could be taken one step further, there could be a selector to chose common secrets, so I could choose a secret type of "AWS" and it would have a few boxes to enter AWS account name, AWS user name (not key), and a generic box for other info, and this would all be shown in clear text. |
Beta Was this translation helpful? Give feedback.
-
I agree with this, some additional information is needed in association with the secret. This is especially difficult when using company-wide secrets and at least these fields would be very useful to work in a company with multiple teams:
|
Beta Was this translation helpful? Give feedback.
-
For anyone in the future, our workaround was to define a secret called Note, all secrets must have a value. Otherwise, GitHub won't let you create them. Put anything as a value for this secret. Then, create a # GitHub Secrets
Documentation for used GitHub secrets.
**On any changes to used secrets/tokens, update this file**
<table>
<thead>
<tr>
<th>Name</th>
<th>Active</th>
<th>Description</th>
<th>Used by</th>
</tr>
</thead>
<tbody>
<tr>
<td>QODANA_TOKEN</td>
<td>No</td>
<td>
Used by JetBrain's Qodana service
</td>
<td>
<a href="https://github.com/specify/specify7/pull/2710">
#2710
</a>
</td>
</tr>
<tr>
<td>WEBLATE_API_TOKEN</td>
<td>Yes</td>
<td>
Regular weblate organization token. Used for API calls
</td>
<td>
<a href="https://github.com/specify/specify7/blob/production/.github/workflows/test.yml">
test.yml
</a>,
<a href="https://github.com/specify/specify7/blob/weblate-localization/.github/workflows/push.yml">
push.yml
</a>
</td>
</tr>
<tr>
<td>WEBLATE_PUSH_TO_GITHUB</td>
<td>Yes</td>
<td>
Personal GitHub token (from @maxpatiiuk account). Personal token
is used to bypass branch protection rules (to allow Weblate to
push directly to production branch)
</td>
<td>
<a href="https://github.com/specify/specify7/blob/weblate-localization/.github/workflows/push.yml">
push.yml
</a>
</td>
</tr>
</tbody>
</table> Keep in mind though, that this file would be public, so don't put any sensitive information in there. On a positive side, people cloning your repository would have an idea of what secrets they need to add to get everything working |
Beta Was this translation helpful? Give feedback.
-
It would be really nice if secrets could have additional context added to them like a comment.
Yes its a good practice to name your secrets something self-descriptive, but sometimes additional context can be useful.
Example
Beta Was this translation helpful? Give feedback.
All reactions