Skip to content

Commit

Permalink
Fixed step that creates the release start tag when starting a new ver…
Browse files Browse the repository at this point in the history
…sion

Signed-off-by: Andreas Maier <[email protected]>
  • Loading branch information
andy-maier committed Aug 19, 2024
1 parent 5f7054a commit e01ca81
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 18 deletions.
1 change: 1 addition & 0 deletions changes/noissue.3.fix.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Dev: Fixed step that creates the release start tag when starting a new version.
31 changes: 13 additions & 18 deletions docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -482,31 +482,19 @@ local clone of the zhmc-prometheus-exporter Git repo.
git pull
git checkout -b start_${MNU}
3. Add an initial Git tag for the new version

Note: An initial tag is necessary because the automatic version calculation
done by setuptools-scm uses the most recent tag in the commit history and
increases the least significant part of the version by one, without
providing any controls to change that behavior.

.. code-block:: sh
git tag ${MNU}a0
git push --tags
4. Commit your changes and push them to the remote repo:
3. Commit your changes and push them to the remote repo:

.. code-block:: sh
git commit -asm "Start ${MNU}"
git push --set-upstream origin start_${MNU}
5. On GitHub, create a milestone for the new version ``M.N.U``.
4. On GitHub, create a milestone for the new version ``M.N.U``.

You can create a milestone in GitHub via Issues -> Milestones -> New
Milestone.

6. On GitHub, create a Pull Request for branch ``start_M.N.U``.
5. On GitHub, create a Pull Request for branch ``start_M.N.U``.

Important: When creating Pull Requests, GitHub by default targets the
``master`` branch. When starting a version based on a stable branch, you
Expand All @@ -516,26 +504,33 @@ local clone of the zhmc-prometheus-exporter Git repo.

Set the milestone of that PR to the new version ``M.N.U``.

7. On GitHub, go through all open issues and pull requests that still have
6. On GitHub, go through all open issues and pull requests that still have
milestones for previous releases set, and either set them to the new
milestone, or to have no milestone.

Note that when the release process has been performed as described, there
should not be any such issues or pull requests anymore. So this step here
is just an additional safeguard.

8. On GitHub, once the checks for the Pull Request for branch ``start_M.N.U``
7. On GitHub, once the checks for the Pull Request for branch ``start_M.N.U``
have succeeded, merge the Pull Request (no review is needed). This
automatically deletes the branch on GitHub.

9. Update and clean up the local repo:
8. Add release start tag and clean up the local repo:

Note: An initial tag is necessary because the automatic version calculation
done by setuptools-scm uses the most recent tag in the commit history and
increases the least significant part of the version by one, without
providing any controls to change that behavior.

.. code-block:: sh
git checkout ${BRANCH}
git pull
git branch -D start_${MNU}
git branch -D -r origin/start_${MNU}
git tag -f ${MNU}a0
git push -f --tags
Building the distribution archives
----------------------------------
Expand Down

0 comments on commit e01ca81

Please sign in to comment.