-
Notifications
You must be signed in to change notification settings - Fork 119
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
[develop]: Add GitHub Actions to check that Technical Docs are up-to-date #1152
[develop]: Add GitHub Actions to check that Technical Docs are up-to-date #1152
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The changes look good to me! I would suggest removing the feature/doc-actions
branch from the workflow_dispatch
in .github/workflows/doc_tests.yaml
, since this feature branch won't require manual submission of the GHA once this PR is merged.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM -- approved pending change (removal of github action
) asked for by @MichaelLueken.
DESCRIPTION OF CHANGES:
This PR:
-W
flag so that documentation build warnings register as error--remove-old
flag can be used to check Tech DocsType of change
TESTS CONDUCTED:
Ran fundamental tests on Hera & Hercules. All passed.
I also tested the GitHub Actions functionality by adding or deleting test files and checking that the GitHub Actions behavior (pass/fail) corresponded to the expected behavior.
DEPENDENCIES:
N/A
DOCUMENTATION:
Documentation was added to the Contributor's Guide to explain technical documentation standards.
ISSUE:
Closes Issue #1151
CHECKLIST
CONTRIBUTORS (optional):