-
Notifications
You must be signed in to change notification settings - Fork 181
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
Generate diagrams for CI/CD and automatically commit them to repo #1678
Comments
Chris briefed us during this sprint's review and will likely finish this Friday, during the very beginning of the next sprint. |
@aj-stein-nist I PRed this here #1716 This is what a commit would look like (excluding the workflow file): https://github.com/Compton-NIST/OSCAL/pull/3/files It could be more flexible for the commit/PR side, but see what we think for the content side and how it would work in the repo. Once we get it where we want it, we can add to other repos. |
This came up today in standup. @aj-stein-nist owes Chris a review NLT than standup tomorrow. |
FTR: The last update to the workflow commits docs to build/ci-cd/docs Example: https://github.com/Compton-NIST/OSCAL/tree/auto-ci-docs-update/build/ci-cd/docs |
Kind of a reminder to myself, but for future automation:
I don't think it can append to the PR, so this assumption is why I move to approval above. If the docs are generated just prior to merge, is there a way to combine without having a separate pull request? If not, should it just be a pull request with a particularly named branch that is dynamically generated? If automated, how is the target chosen? Could it be based on the approved PR target? |
* Add workflow for CI diagrams #1678 * Adjust output path Co-authored-by: A.J. Stein <[email protected]> * Pin action to hash. Co-authored-by: A.J. Stein <[email protected]> * Update to action supporting named markdown file. * Update to latest inspector action. * Run on feature branch pushes and place docs in build/ci-cd/docs * Set workflow to execute on PRs opened on feature- branches in the workflows folder. * Apply suggestions from code review --------- Co-authored-by: A.J. Stein <[email protected]>
User Story
As a NIST or OSCAL community developer, in order to understand the the components of the CI/CD system in GitHub Actions, I would like an updated diagram to show the current state of CI/CD and adjust for changes.
Goals
Dependencies
Acceptance Criteria
The text was updated successfully, but these errors were encountered: