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

Build docs #236

Merged
merged 5 commits into from
Dec 9, 2022
Merged

Build docs #236

merged 5 commits into from
Dec 9, 2022

Conversation

joshua-cogliati-inl
Copy link
Collaborator

@joshua-cogliati-inl joshua-cogliati-inl commented Dec 5, 2022


Pull Request Description

What issue does this change request address?

Closes #235

What are the significant changes in functionality due to this change request?

Adds a github action to automatically build the pdf documents.


For Change Control Board: Change Request Review

The following review must be completed by an authorized member of the Change Control Board.

  • 1. Review all computer code.
  • 2. If any changes occur to the input syntax, there must be an accompanying change to the user manual and xsd schema. If the input syntax change deprecates existing input files, a conversion script needs to be added (see Conversion Scripts).
  • 3. Make sure the Python code and commenting standards are respected (camelBack, etc.) - See on the wiki for details.
  • 4. Automated Tests should pass.
  • 5. If significant functionality is added, there must be tests added to check this. Tests should cover all possible options. Multiple short tests are preferred over one large tes.
  • 6. If the change modifies or adds a requirement or a requirement based test case, the Change Control Board's Chair or designee also needs to approve the change. The requirements and the requirements test shall be in sync.
  • 7. The merge request must reference an issue. If the issue is closed, the issue close checklist shall be done.
  • 8. If an analytic test is changed/added, the the analytic documentation must be updated/added.
  • 9. If any test used as a basis for documentation examples have been changed, the associated documentation must be reviewed and assured the text matches the example.

@PaulTalbot-INL
Copy link
Collaborator

What happens if we merge two PRs to devel in rapid succession? Will the manual build before the second devel merge, or cancel-and-restart, or they'll just run in parallel and the second will probably replace the first when it finishes?

@joshua-cogliati-inl
Copy link
Collaborator Author

joshua-cogliati-inl commented Dec 5, 2022

What happens if we merge two PRs to devel in rapid succession? Will the manual build before the second devel merge, or cancel-and-restart, or they'll just run in parallel and the second will probably replace the first when it finishes?

It will build them both, in order, and upload them both, and the last one will be the one that people see in the end. (Edited)

path: |
doc/pdfs
doc/sqa/sqa_built_documents
- run: update_heron_docs.sh doc/pdfs/*.pdf doc/sqa/sqa_built_documents/*.pdf
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

where does the update_heron_docs.sh script live? Should it be added with this PR?

@PaulTalbot-INL PaulTalbot-INL merged commit cef52e1 into idaholab:devel Dec 9, 2022
@joshua-cogliati-inl joshua-cogliati-inl deleted the build_docs branch December 9, 2022 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[TASK] Create github action to automatically build documentation
2 participants