Adding documentation about secrets and tokens #311
Conversation
github-actions
bot
added
the
documentation
|
The core of the PR is done. Two things:
Feel free to review for format and approach. |
|
DO NOT MERGE YET |
| | Full control of codespaces. | | | ||
| +-------------------------------------------------------------------------------------+------------------------+ | ||
| | **codespace:secrets** | |:x:| | | ||
| | Ability to create, read, update, and delete codespace secrets. | | |
There was a problem hiding this comment.
Solve Vale issues. You will need to add both Codespace and codespace. Same goes for Codespaces and codespaces.
| ************** | ||
|
|
||
| The value of the ``PYPI_TOKEN`` token is unique for each repository. | ||
| This token is used for authentication when uploading libraries to the public PyPI index. |
There was a problem hiding this comment.
@ansys/pyansys-core We could specify/remember how to get this token maybe. I don't know if it is relevant here.
| ``TWINE_TOKEN`` | ||
| *************** | ||
|
|
||
| The ``TWINE_TOKEN`` token is used for authentication when uploading libraries to PyPI. |
There was a problem hiding this comment.
@germa89 @RobPasMue I would specify the difference with the PYPI_TOKEN described above.
There was a problem hiding this comment.
I'm not super convinced of its difference.
| ~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| +-------------------------------------+------------------------------------+---------------------------------------+-------------------------------------------+----------------------------------------------------------------------------------------------+ | ||
| | **Secret** | **Repository access** | **Token** | **Value** | **Description** | |
There was a problem hiding this comment.
| | **Secret** | **Repository access** | **Token** | **Value** | **Description** | | |
| | **Secret** | **Repository access** | **Token** | **Value** | **description** | |
| | | A user's followers. | | | ||
| +----------------------------------------------------------------+----------------------------------------+ | ||
| | | **GPG keys** | No access | | ||
| | | View and manage a user's GPG keys. | | |
There was a problem hiding this comment.
Will users know what a GPG key is? I don't! (Thank goodness for Google! Let readers search for an answer if they are clueless like me!
| | **read:audit_log** | |:x:| | | ||
| | Read access of audit log. | | | ||
| +-------------------------------------------------------------------------------------+------------------------+ | ||
| | **codespace** | |:x:| | |
There was a problem hiding this comment.
So, codespace is lower case here in this section, if this influences your response to the capitalization question posed earlier?
There was a problem hiding this comment.
Definitely Github needs a Kathy.
I need to update this yes.
There was a problem hiding this comment.
I'm going to go with "C"odespace(s)
There was a problem hiding this comment.
@germa89 Virtually all stye guides say not to use (s) but rather to use the plural form instead.
| ``HUGO_THEME_TOKEN`` | ||
| ******************** | ||
|
|
||
| The ``HUGO_THEME_TOKEN`` token is used to ... # todo: to be added |
There was a problem hiding this comment.
We don't want the unfinished stuff visible in the public doc, do we?!
There was a problem hiding this comment.
No no... in fact, this part needs to be deleted. Because it is not used by (almost) any repo.
Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com> Co-authored-by: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com> Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
|
Hello @MaxJPRey, @clatapie, @Revathyvenugopal162, @RobPasMue, @germa89, @jorgepiloto! If this issue needs to remain open, please comment below with If you want this repository to be excluded from this automated maintenance process, please let us know by filling in the opt-out request form. |
@clatapie -- interesting, I think we need to improve the logic. Apparently it is also detecting very old PRs. |
This PR aims to document the usage of
secretsandtokensin the orgs.It add the following sections:
The idea is to have
secretsandtokens.secretscan be used to storetokens, in that case, the secrets table will have a "value" pointing to the correspondingtoken. Remember thattokenscan have names (and descriptions), and we should use that to identify thetokensrather than thesecretitself.One I have access to the bot, I will have access to the list of permissions of each bot
tokens. Then I will fill thetokentable.