From 499f11c690e3333b34e4115ebef02c32a664e91b Mon Sep 17 00:00:00 2001 From: "Balos, Cody, J" Date: Fri, 20 Dec 2024 10:58:32 -0800 Subject: [PATCH] fix more tabs from my vim --- .../source/developers/releases/Checklist.rst | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/superbuild/source/developers/releases/Checklist.rst b/doc/superbuild/source/developers/releases/Checklist.rst index 0f6ddc94f4..4f0db9a526 100644 --- a/doc/superbuild/source/developers/releases/Checklist.rst +++ b/doc/superbuild/source/developers/releases/Checklist.rst @@ -78,7 +78,7 @@ web pages. #. Update version numbers of third party libraries in the Install Guide in doc directory. -#. Open a pull request from the release branch to ``develop``. +#. Open a pull request from the release branch to ``develop``. Release Procedure ================= @@ -95,10 +95,10 @@ Release Procedure git checkout main git pull # main should be up to date with origin/main now git merge --ff-only develop # we want to do a fast-forward merge (no merge commit) - git tag -m 'SUNDIALS Release vX.Y.Z’ vX.Y.Z + git tag -m 'SUNDIALS Release vX.Y.Z' vX.Y.Z git push --tags origin main - .. note:: + .. note:: The final step (pushing to main) requires changing the GitHub repository settings to allow whoever is doing the push an exception in the ``main`` branch protection rules. @@ -107,15 +107,15 @@ Release Procedure Use the ``tarscript`` shell script under the ``scripts`` directory. This also compiles the documents (user guides and example docs) and creates all tarballs in their final form, appropriate for uploading as artifacts to the GitHub release. - - .. warning:: - + + .. warning:: + Creating the tarballs on a Mac can cause issues. Furthermore, it is important to wait - to create the tarballs until readthedocs finishes building the new release docs so - that cross-references have valid links. + to create the tarballs until readthedocs finishes building the new release docs so + that cross-references have valid links. #. Draft the release on GitHub and attach the tarballs as well as the example documentation PDFs. - The description of the release is just a copy of the ``CHANGELOG.md`` notes for the release with + The description of the release is just a copy of the ``CHANGELOG.md`` notes for the release with hard line-wraps removed. #. Now prepare SUNDIALS for the next release cycle using the following steps: @@ -125,7 +125,7 @@ Release Procedure git checkout develop git checkout -b maintenance/start-new-release-cycle pushd scripts/ && ./startReleaseCycle.sh && popd - git add . && git commit -m “start new release cycle” + git add . && git commit -m 'start new release cycle' git push -u origin maintenance/start-new-release-cycle # Now open the PR to develop on GitHub.