-
Notifications
You must be signed in to change notification settings - Fork 165
Closed
Labels
confirmedThe scope is clear, ready for implementationThe scope is clear, ready for implementationdocumentationImprovements or additions to documentationImprovements or additions to documentationinternalPRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)
Description
Description of the improvement
Summary of the proposal
With the number of workflows
and scripts
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
ijemmy and saragerion
Metadata
Metadata
Assignees
Labels
confirmedThe scope is clear, ready for implementationThe scope is clear, ready for implementationdocumentationImprovements or additions to documentationImprovements or additions to documentationinternalPRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)
Type
Projects
Status
Shipped