Merge pull request idaholab#26540 from cticenhour/sqa-revision-log

Add Changelog Revision section to RTM
cticenhour · Jan 22, 2024 · a9c114d · a9c114d
2 parents 8f969b5 + deba03d
commit a9c114d
Show file tree

Hide file tree

Showing 24 changed files with 138 additions and 0 deletions.
diff --git a/framework/doc/content/sqa/framework_rtm.md b/framework/doc/content/sqa/framework_rtm.md
@@ -38,6 +38,11 @@ can be found in the [Software Test Plan](sqa/framework_stp.md).
 !! pre-test-finish
 !template-end!
 
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
+
 !template item key=functional-requirements
 !sqa requirements collections=FUNCTIONAL category=framework
 

diff --git a/framework/doc/content/templates/sqa/rtm.md.template b/framework/doc/content/templates/sqa/rtm.md.template
@@ -91,6 +91,24 @@ includes:
 - The steps to validate the test result including any acceptance criteria.
 !template-end!
 
+### Changelog Issue Revisions id=log-revisions
+
+Errors in changelog references can sometimes occur as a result of typos or conversion errors. If
+any need to be noted by the development team, they will be noted here.
+
+!template! field key=log-revisions
+If errors are found in issue references related to the changelog (e.g., commit history), these
+should be noted here. The commit in which the incorrect issue reference occurs should be listed, and
+the correct issue should be added alongside each entry. Relevant links to all items are required.
+An example of this is shown below:
+
+!table
+| MOOSE Commit | Incorrect Referenced Issue | Correct Referenced Issue |
+| - | - | - |
+| [48db61](https://github.com/idaholab/moose/commit/48db61307ed87b58a96e944215f13378138cf7bc) | idaholab/sockeye#19845 | [idaholab/sockeye#130](https://github.inl.gov/ncrc/sockeye/issues/130) |
+
+!template-end!
+
 ## System Requirements Traceability id=system-requirements
 
 ### Functional Requirements id=functional-requirements

diff --git a/modules/contact/doc/content/modules/contact/sqa/contact_rtm.md b/modules/contact/doc/content/modules/contact/sqa/contact_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include contact_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/modules/doc/content/sqa/moose_rtm.md b/modules/doc/content/sqa/moose_rtm.md
@@ -6,6 +6,16 @@
 !template item key=system-scope
 !include system_scope.md
 
+!template! item key=log-revisions
+The following known log revisions exist for the {{module}} module:
+
+!table
+| MOOSE Commit | Incorrect Referenced Issue | Correct Referenced Issue |
+| - | - | - |
+| [48db61](https://github.com/idaholab/moose/commit/48db61307ed87b58a96e944215f13378138cf7bc) | idaholab/sockeye#19845 | [idaholab/sockeye#130](https://github.inl.gov/ncrc/sockeye/issues/130) |
+
+!template-end!
+
 !template item key=functional-requirements
 All of the requirements for [!ac](MOOSE) are provided in the dependent [!ac](RTM) documents, please
 refer to the documents listed in [#assumptions-and-dependencies].

diff --git a/...ectromagnetics/doc/content/modules/electromagnetics/sqa/electromagnetics_rtm.md b/...ectromagnetics/doc/content/modules/electromagnetics/sqa/electromagnetics_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include electromagnetics_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/...uid_properties/doc/content/modules/fluid_properties/sqa/fluid_properties_rtm.md b/...uid_properties/doc/content/modules/fluid_properties/sqa/fluid_properties_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include fluid_properties_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/modules/fsi/doc/content/modules/fsi/sqa/fsi_rtm.md b/modules/fsi/doc/content/modules/fsi/sqa/fsi_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include fsi_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/modules/heat_transfer/doc/content/modules/heat_transfer/sqa/heat_transfer_rtm.md b/modules/heat_transfer/doc/content/modules/heat_transfer/sqa/heat_transfer_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include heat_transfer_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/modules/level_set/doc/content/modules/level_set/sqa/level_set_rtm.md b/modules/level_set/doc/content/modules/level_set/sqa/level_set_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include level_set_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/modules/misc/doc/content/modules/misc/sqa/misc_rtm.md b/modules/misc/doc/content/modules/misc/sqa/misc_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include misc_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/modules/navier_stokes/doc/content/modules/navier_stokes/sqa/navier_stokes_rtm.md b/modules/navier_stokes/doc/content/modules/navier_stokes/sqa/navier_stokes_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include navier_stokes_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/modules/optimization/doc/content/modules/optimization/sqa/optimization_rtm.md b/modules/optimization/doc/content/modules/optimization/sqa/optimization_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include optimization_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/modules/phase_field/doc/content/modules/phase_field/sqa/phase_field_rtm.md b/modules/phase_field/doc/content/modules/phase_field/sqa/phase_field_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include phase_field_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/modules/porous_flow/doc/content/modules/porous_flow/sqa/porous_flow_rtm.md b/modules/porous_flow/doc/content/modules/porous_flow/sqa/porous_flow_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include porous_flow_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/modules/ray_tracing/doc/content/sqa/ray_tracing_rtm.md b/modules/ray_tracing/doc/content/sqa/ray_tracing_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include ray_tracing_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/modules/rdg/doc/content/sqa/rdg_rtm.md b/modules/rdg/doc/content/sqa/rdg_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include rdg_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/modules/reactor/doc/content/modules/reactor/sqa/reactor_rtm.md b/modules/reactor/doc/content/modules/reactor/sqa/reactor_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include reactor_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/modules/scalar_transport/doc/content/sqa/scalar_transport_rtm.md b/modules/scalar_transport/doc/content/sqa/scalar_transport_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include scalar_transport_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/...lid_properties/doc/content/modules/solid_properties/sqa/solid_properties_rtm.md b/...lid_properties/doc/content/modules/solid_properties/sqa/solid_properties_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include solid_properties_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/...ochastic_tools/doc/content/modules/stochastic_tools/sqa/stochastic_tools_rtm.md b/...ochastic_tools/doc/content/modules/stochastic_tools/sqa/stochastic_tools_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include stochastic_tools_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/...nsor_mechanics/doc/content/modules/tensor_mechanics/sqa/tensor_mechanics_rtm.md b/...nsor_mechanics/doc/content/modules/tensor_mechanics/sqa/tensor_mechanics_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include tensor_mechanics_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/...hydraulics/doc/content/modules/thermal_hydraulics/sqa/thermal_hydraulics_rtm.md b/...hydraulics/doc/content/modules/thermal_hydraulics/sqa/thermal_hydraulics_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include thermal_hydraulics_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/modules/xfem/doc/content/modules/xfem/sqa/xfem_rtm.md b/modules/xfem/doc/content/modules/xfem/sqa/xfem_rtm.md
@@ -7,3 +7,8 @@
 !template! item key=system-scope
 !include xfem_srs.md start=system-scope-begin end=system-scope-finish
 !template-end!
+
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
diff --git a/python/doc/content/python/sqa/python_rtm.md b/python/doc/content/python/sqa/python_rtm.md
@@ -20,6 +20,11 @@
 !include framework_rtm.md start=pre-test-begin end=pre-test-finish replace=['framework_stp.md', 'python_stp.md']
 !template-end!
 
+!template! item key=log-revisions
+The changelog for all code residing in the MOOSE repository is located in the
+[MOOSE RTM](moose_rtm.md#log-revisions optional=True).
+!template-end!
+
 !template item key=functional-requirements
 !sqa requirements collections=FUNCTIONAL category=python