Skip to content
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

Add metadata to each GitHub Action workflow to improve documentation #1679

Closed
6 tasks
aj-stein-nist opened this issue Mar 1, 2023 · 1 comment
Closed
6 tasks

Comments

@aj-stein-nist
Copy link
Contributor

User Story

As a NIST OSCAL developer, in order to ensure efficient, automated documentation of the GHA workflows, I would like metadata added to each GHA workflow so a quick summary of the workflows purpose can be added to documentation.

Goals

  • Add developer friendly descriptions to each GHA worfklow with a high-level summary regarding its purpose.

Dependencies

Acceptance Criteria

  • Necessary changes are made to NIST-Compton/Inspector
  • Every GHA workflow has a description added as a string in the env block to integrate with NIST-Compton/Inspector
  • 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
Copy link
Contributor Author

Given that our CI/CD was significantly redesigned and simplified in #1857, I have decided to close this issue for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant