-
Notifications
You must be signed in to change notification settings - Fork 146
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: document CI/CD behavior / implementation #1038
Comments
Most of the automation has now been documented in the Processes section of the documentation as well as the Maintainers handbook. Additionally, each workflow has now a mini documentation at the top of the file that explains how it works and its purpose. We also have a couple dedicated issues that should be addressed during the next few iterations: With this in mind, I'll be closing this issue as completed. |
This issue is now closed. Please be mindful that future comments are hard for our team to see. If you need more assistance, please either tag a team member or open a new issue that references this one. If you wish to keep having a conversation with other community members under this issue feel free to do so. |
Description of the improvement
Summary of the proposal
With the number of
workflows
andscripts
growing in our CI/CD processes (based on GitHub Actions) there's a need of documenting the relationships between each workflow/script and also the different triggers.The proposal is to create a
.github/workflows/README.md
file and have a short explanation + diagram of each major workflow, similar to what done in this comment of #1023.How, where did you look for information
N/A
Missing or unclear documentation
.github/workflows/README.md
Improvement
Creating the doc would help all existing maintainers to have context on how the workflows. This would also be useful to onboard additional maintainers / collaborators in the future.
Related existing documentation
N/A
Related issues, RFCs
#1023
The text was updated successfully, but these errors were encountered: