From 97860260ef24bb468a83efb69aa5ce02da39824a Mon Sep 17 00:00:00 2001 From: yardasol Date: Mon, 7 Feb 2022 16:30:19 -0600 Subject: [PATCH 1/7] added more reviewers to release notes --- doc/releasenotes/v0.4.0.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/releasenotes/v0.4.0.rst b/doc/releasenotes/v0.4.0.rst index fdc05d1e6..cfcea70a6 100644 --- a/doc/releasenotes/v0.4.0.rst +++ b/doc/releasenotes/v0.4.0.rst @@ -14,6 +14,8 @@ Release notes for v0.4.0 .. _jsonschema: https://github.com/Julian/jsonschema .. _@yardasol: https://github.com/yardasol .. _@abachma2: https://github.com/abachma2 +.. _@ZoeRichter: https://github.com/ZoeRichter +.. _@gwenchee: https://github.com/gwenchee .. _@LukeSeifert: https://github.com/LukeSeifert .. _@munkm: https://github.com/munkm @@ -174,5 +176,7 @@ The following people reviewed code for this release of SaltProc: `@gh_username `_ - `@abachma2`_ +- `@ZoeRichter`_ +- `@gwenchee`_ - `@LukeSeifert`_ - `@munkm`_ From 61dc67f3e114a4692c96a08703ae10e5405e3bcd Mon Sep 17 00:00:00 2001 From: yardasol Date: Mon, 7 Feb 2022 16:37:42 -0600 Subject: [PATCH 2/7] add python api changes --- doc/releasenotes/v0.4.0.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/releasenotes/v0.4.0.rst b/doc/releasenotes/v0.4.0.rst index cfcea70a6..3547fb5db 100644 --- a/doc/releasenotes/v0.4.0.rst +++ b/doc/releasenotes/v0.4.0.rst @@ -51,7 +51,7 @@ New Features - `Refactor app.py and simulation.py to prepare for OpenMC support `_ by `@yardasol`_ - `New input file format that is checked against a verifiable JSON Schema `_ by `@yardasol`_ -- `Release notes in the online docs `_ by `@yardasol`_ +- `Release notes in the online docs `_ by `@yardasol`_ --------- @@ -98,6 +98,9 @@ Python API Changes - (new) → ``Depcode.switch_to_next_geometry`` - (new) → ``Depcode.read_depcode_info`` - (new) → ``Depcode.read_repcode_step_param`` + - ``DepcodeSerpent.sss_meta_zzz`` → ``DepcodeSerpent.convert_nuclide_name_serpent_to_zam`` + - ``DepcodeSerpent.get_tra_or_dec`` → ``DepcodeSerpent.create_nuclide_name_map_zam_to_serpent`` + - ``DepcodeSerpent.read_depcode_template`` → ``DepcodeSerpent.read_plaintext_file`` - Updated input file structure: @@ -123,7 +126,7 @@ Python API Changes - (new) → ``App.reactor_inp['volume']`` - (new) → ``App.reactor_inp['mass_flowrate']`` - ``App.power_levels`` - - ``App.depl_hist`` + - ``App.depl_hist`` → ``App.reactor_inp['dep_step_length_cumulative']`` - The following class attributes have been added/(re)moved: @@ -146,7 +149,7 @@ Python API Changes - ``Depcode.write_depcode_input`` - ``Depcode.write_mat_file`` - ``DepcodeSerpent.read_depcode_template`` - + - ``DepcodeSerpent.create_nuclide_map_serpent_to_zam`` ------------ Contributors From 829b63976969177c9d9434d2bdac150a6c7e1c1e Mon Sep 17 00:00:00 2001 From: yardasol Date: Mon, 7 Feb 2022 16:43:54 -0600 Subject: [PATCH 3/7] fix release notes formatting --- doc/releasenotes/template.rst | 24 ++++++++---------------- doc/releasenotes/v0.4.0.rst | 24 ++++++++---------------- 2 files changed, 16 insertions(+), 32 deletions(-) diff --git a/doc/releasenotes/template.rst b/doc/releasenotes/template.rst index 5fbd7b05f..a906d6474 100644 --- a/doc/releasenotes/template.rst +++ b/doc/releasenotes/template.rst @@ -14,9 +14,8 @@ Release notes for vx.x.x -------- Summary -------- +======= .. Describe generally the features of this release @@ -24,9 +23,8 @@ Summary ------------------- Dependency Changes ------------------- +================== .. Describe any new/removed/modified package dependencies @@ -34,9 +32,8 @@ Dependency Changes ------------- New Features ------------- +============ .. Describe any new features to the code. @@ -44,9 +41,8 @@ New Features ---------- Bug Fixes ---------- +========= .. Describe any bug fixes. @@ -54,9 +50,8 @@ Bug Fixes --------------- Script Changes --------------- +============== .. Describe any script additions/modifications/removals @@ -64,9 +59,8 @@ Script Changes ------------------- Python API Changes ------------------- +================== .. Describe any changes to the API @@ -74,9 +68,8 @@ Python API Changes ------------- Contributors ------------- +============ .. List of people who contributed features and fixes to this release @@ -88,9 +81,8 @@ The following people contributed code to this release of SaltProc: ---------- Reviewers ---------- +========= .. List of people who reviewed PRs for this release diff --git a/doc/releasenotes/v0.4.0.rst b/doc/releasenotes/v0.4.0.rst index 3547fb5db..894da07a0 100644 --- a/doc/releasenotes/v0.4.0.rst +++ b/doc/releasenotes/v0.4.0.rst @@ -20,9 +20,8 @@ Release notes for v0.4.0 .. _@munkm: https://github.com/munkm -------- Summary -------- +======= .. Describe generally the features of this release @@ -30,9 +29,8 @@ Summary This version of SaltProc refactors the code in preparation for supporting OpenMC. ------------------- Dependency Changes ------------------- +================== .. Describe any new/removed/modified package dependencies @@ -42,9 +40,8 @@ Dependency Changes - (new) → `jsonschema`_ ------------- New Features ------------- +============ .. Describe any new features to the code. @@ -54,9 +51,8 @@ New Features - `Release notes in the online docs `_ by `@yardasol`_ ---------- Bug Fixes ---------- +========= .. Describe any bug fixes. @@ -64,9 +60,8 @@ Bug Fixes - `Fix typos in process_j312.bash `_ --------------- Script Changes --------------- +============== .. Describe any script additions/modifications/removals @@ -76,9 +71,8 @@ Script Changes - ``process_j312.sh`` → ``process_j312.bash`` ------------------- Python API Changes ------------------- +================== - New tests for previously untested functions in ``simulation.py``: @@ -151,9 +145,8 @@ Python API Changes - ``DepcodeSerpent.read_depcode_template`` - ``DepcodeSerpent.create_nuclide_map_serpent_to_zam`` ------------- Contributors ------------- +============ .. List of people who contributed features and fixes to this release @@ -166,9 +159,8 @@ The following people contributed code to this release of SaltProc: - `@yardasol`_ ---------- Reviewers ---------- +========= .. List of people who reviewed PRs for this release From 94578f4105008c7226ac5affaec3102e894dc4c3 Mon Sep 17 00:00:00 2001 From: yardasol Date: Tue, 8 Feb 2022 12:57:52 -0600 Subject: [PATCH 4/7] added note for in-production release notes to template --- doc/releasenotes/template.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/releasenotes/template.rst b/doc/releasenotes/template.rst index a906d6474..44b82261a 100644 --- a/doc/releasenotes/template.rst +++ b/doc/releasenotes/template.rst @@ -12,6 +12,7 @@ Release notes for vx.x.x Links to packages/issues/bug fixes/contributors/reviewers +.. note:: These release notes are currently in production. Summary From 4b2ae178286931c377b8f61b919c55d7b31a8fac Mon Sep 17 00:00:00 2001 From: yardasol Date: Tue, 8 Feb 2022 12:59:42 -0600 Subject: [PATCH 5/7] adjust location of note and add to v0.4.0 notes --- doc/releasenotes/template.rst | 3 ++- doc/releasenotes/v0.4.0.rst | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/releasenotes/template.rst b/doc/releasenotes/template.rst index 44b82261a..271777a93 100644 --- a/doc/releasenotes/template.rst +++ b/doc/releasenotes/template.rst @@ -2,6 +2,8 @@ Release notes for vx.x.x ======================== +.. note:: These release notes are currently in production. + .. When documenting a bug fix or feature, please do so in the following format @@ -12,7 +14,6 @@ Release notes for vx.x.x Links to packages/issues/bug fixes/contributors/reviewers -.. note:: These release notes are currently in production. Summary diff --git a/doc/releasenotes/v0.4.0.rst b/doc/releasenotes/v0.4.0.rst index 894da07a0..5294f9f92 100644 --- a/doc/releasenotes/v0.4.0.rst +++ b/doc/releasenotes/v0.4.0.rst @@ -2,6 +2,8 @@ Release notes for v0.4.0 ======================== +.. note:: These release notes are currently in production. + .. When documenting a bug fix or feature, please do so in the following format From 3967bb84c299ebb76e66e4f473c2e69db5d268db Mon Sep 17 00:00:00 2001 From: yardasol Date: Tue, 8 Feb 2022 13:00:21 -0600 Subject: [PATCH 6/7] typo fix in v0.4.0.rst --- doc/releasenotes/v0.4.0.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/releasenotes/v0.4.0.rst b/doc/releasenotes/v0.4.0.rst index 5294f9f92..cd6a90410 100644 --- a/doc/releasenotes/v0.4.0.rst +++ b/doc/releasenotes/v0.4.0.rst @@ -68,7 +68,7 @@ Script Changes .. Describe any script additions/modifications/removals -- The following scripts hav been renamed: +- The following scripts have been renamed: - ``process_j312.sh`` → ``process_j312.bash`` From 53942661157aa2d6038bd1402131e6f250448365 Mon Sep 17 00:00:00 2001 From: yardasol Date: Tue, 8 Feb 2022 13:07:52 -0600 Subject: [PATCH 7/7] update next-release-minor workflow to remove the 'in-production' note when the release is published --- .github/workflows/next-release-minor.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/next-release-minor.yml b/.github/workflows/next-release-minor.yml index df6b82158..3494f6278 100644 --- a/.github/workflows/next-release-minor.yml +++ b/.github/workflows/next-release-minor.yml @@ -62,6 +62,7 @@ jobs: git config --local user.email "github-actions[bot]@users.noreply.github.com" git config --local user.name "github-actions[bot]" echo "Make edits to docfiles" + sed -i "s/\.\. note:: These release notes are currently in production\.//g" doc/releasenotes/${{ env.RELEASE_VERSION }}.rst cp doc/releasenotes/template.rst doc/releasenotes/${{ env.NEW_RELEASE_VERSION }}.rst sed -i "s/vx.x.x/${{ env.NEW_RELEASE_VERSION }}/g" doc/releasenotes/${{ env.NEW_RELEASE_VERSION }}.rst sed -i "s/${{ env.RELEASE_VERSION }}/${{ env.NEW_RELEASE_VERSION }}\n ${{ env.RELEASE_VERSION }}/g" doc/releasenotes/index.rst @@ -71,6 +72,7 @@ jobs: sed -i "s/^# _version_extra = 'dev'/_version_extra = 'dev'/g" saltproc/version.py sed -i "s/^_version_extra = ''# _version_extra = ''/g" saltproc/version.py echo "Add, commit, and push changes" + git add doc/releasenotes/${{ env.RELEASE_VERSION }}.rst git add doc/releasenotes/${{ env.NEW_RELEASE_VERSION }}.rst git add doc/releasenotes/index.rst git commit -am "created ${{ env.NEW_RELEASE_VERSION }} release notes"