docs: improve gha vulnerabilities documentation #645
Merged
Conversation
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
github-actions
bot
added
the
documentation
clatapie
reviewed
Sep 18, 2025
There was a problem hiding this comment.
Thanks for working on it @moe-ad!
I added a few comments especially regarding the explanation of the vulnerabilities.
IMO each vulnerabilities should be structured as follow:
**Vulnerability title**
Brief explanation of the vulnerability / why it is important to fix it.
Link to zizmor documentation for further explanation
.. tab-set::
.. tab-item: Title emphasizing the vulnerability
.. code:: yaml
CICD WITH VULNERABILITY # additional comment to point out the vulnerability
.. tab-item: Title emphasizing the solution
.. code:: yaml
SAFE CICD # additional comment to point out the fix
Any additional note / tips
Feel free to share any views on this structure.
|
@clatapie thanks for the suggestions. I will make adjustments. |
github-actions bot
pushed a commit
that referenced
this pull request
Sep 22, 2025
* docs: improve gha vulnerabilities documentation * docs: fix code block * docs: add content * docs: review suggestions and vale errors
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
closes #643