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

Adding an SCR section to the docs #2090

Draft
wants to merge 25 commits into
base: main
Choose a base branch
from
Draft

Adding an SCR section to the docs #2090

wants to merge 25 commits into from

Conversation

john-science
Copy link
Member

@john-science john-science commented Mar 7, 2025

What is the change? Why is it being made?

Here I add a new process to ARMI. Instead of just a random "release notes" section, every ARMI PR will come with an SCR. This is part of the on-going quality work in ARMI.

Notes:

  1. This PR will be the first PR merged after the release of ARMI 0.5.1.
  2. To reduce merge conflicts, I have not moved over the 0.5.rst release notes yet. I will do that before I merge this.)

SCR Information

Change Type: docs

One-Sentence Description: ARMI now has an automated "SCR" section, instead of a manual "Release Notes" section that has to be tweaked in code.

One-line Impact on Requirements: NA


Checklist

@john-science john-science added the documentation Improvements or additions to documentation label Mar 7, 2025
@john-science john-science requested a review from opotowsky March 7, 2025 00:48
@john-science
Copy link
Member Author

Here is a little proof this works in HTML:

image

image

And you can see proof this works in PDF here: https://github.com/terrapower/armi/actions/runs/13725317705?pr=2090

Copy link
Member

@opotowsky opotowsky left a comment

Choose a reason for hiding this comment

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

Looks good! I know you have to wait to merge, but you have the green check for when you need it.

Update: haha, I submitted this review before checking CI. I'm assuming you're just troubleshooting the token.

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

Successfully merging this pull request may close these issues.

2 participants