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" diff --git a/doc/releasenotes/template.rst b/doc/releasenotes/template.rst index 5fbd7b05f..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 @@ -14,9 +16,8 @@ Release notes for vx.x.x -------- Summary -------- +======= .. Describe generally the features of this release @@ -24,9 +25,8 @@ Summary ------------------- Dependency Changes ------------------- +================== .. Describe any new/removed/modified package dependencies @@ -34,9 +34,8 @@ Dependency Changes ------------- New Features ------------- +============ .. Describe any new features to the code. @@ -44,9 +43,8 @@ New Features ---------- Bug Fixes ---------- +========= .. Describe any bug fixes. @@ -54,9 +52,8 @@ Bug Fixes --------------- Script Changes --------------- +============== .. Describe any script additions/modifications/removals @@ -64,9 +61,8 @@ Script Changes ------------------- Python API Changes ------------------- +================== .. Describe any changes to the API @@ -74,9 +70,8 @@ Python API Changes ------------- Contributors ------------- +============ .. List of people who contributed features and fixes to this release @@ -88,9 +83,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 fdc05d1e6..cd6a90410 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 @@ -14,13 +16,14 @@ 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 -------- Summary -------- +======= .. Describe generally the features of this release @@ -28,9 +31,8 @@ Summary This version of SaltProc refactors the code in preparation for supporting OpenMC. ------------------- Dependency Changes ------------------- +================== .. Describe any new/removed/modified package dependencies @@ -40,21 +42,19 @@ Dependency Changes - (new) → `jsonschema`_ ------------- New Features ------------- +============ .. Describe any new features to the code. - `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`_ ---------- Bug Fixes ---------- +========= .. Describe any bug fixes. @@ -62,21 +62,19 @@ Bug Fixes - `Fix typos in process_j312.bash `_ --------------- 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`` ------------------- Python API Changes ------------------- +================== - New tests for previously untested functions in ``simulation.py``: @@ -96,6 +94,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: @@ -121,7 +122,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: @@ -144,11 +145,10 @@ Python API Changes - ``Depcode.write_depcode_input`` - ``Depcode.write_mat_file`` - ``DepcodeSerpent.read_depcode_template`` + - ``DepcodeSerpent.create_nuclide_map_serpent_to_zam`` - ------------- Contributors ------------- +============ .. List of people who contributed features and fixes to this release @@ -161,9 +161,8 @@ The following people contributed code to this release of SaltProc: - `@yardasol`_ ---------- Reviewers ---------- +========= .. List of people who reviewed PRs for this release @@ -174,5 +173,7 @@ The following people reviewed code for this release of SaltProc: `@gh_username `_ - `@abachma2`_ +- `@ZoeRichter`_ +- `@gwenchee`_ - `@LukeSeifert`_ - `@munkm`_