Generate diagrams for CI/CD and automatically commit them to repo

[aj-stein-nist]

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

• Clarify current understanding of the CI/CD system with accessible diagrams as documentation
• Maintain documentation with the least effort required over time

Dependencies

• Improve CI/CD Diagrams and Documentation #1434 is complete.

Acceptance Criteria

• A PR integrating Compton-NIST/Inspector to run in the CI/CD process and add an updated diagram is created, reviewed, and merged.
• The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.

[aj-stein-nist]

Chris briefed us during this sprint's review and will likely finish this Friday, during the very beginning of the next sprint.

[Compton-US]

@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
This is how it looks in the repository: https://github.com/Compton-NIST/OSCAL/tree/auto-ci-docs-update/build/ci-cd/docs

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.

[aj-stein-nist]

This came up today in standup. @aj-stein-nist owes Chris a review NLT than standup tomorrow.

[Compton-US]

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

[Compton-US]

Kind of a reminder to myself, but for future automation:

• If someone changes a workflow and submits a PR on a feature branch...
  • Upon approval of the PR, but before merge:
    • Workflow could generate CI doc
    • What should happen next?

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?