Skip to content

Commit

Permalink
Added release step to check and fix dependabot alerts
Browse files Browse the repository at this point in the history
Details:

* Dev: Added to the release instructions to check and fix dependabot issues,
  and to roll back any fixes into any maintained stable branches.

Signed-off-by: Andreas Maier <[email protected]>
  • Loading branch information
andy-maier committed Aug 17, 2024
1 parent 5217c8b commit 97a3ae3
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 9 deletions.
2 changes: 2 additions & 0 deletions changes/noissue.3.cleanup.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Dev: Added to the release instructions to check and fix dependabot issues,
and to roll back any fixes into any maintained stable branches.
25 changes: 16 additions & 9 deletions docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -306,15 +306,22 @@ local clone of the zhmc-prometheus-exporter Git repo.

Roll back the PR into any maintained stable branches.

4. Create a topic branch for the version that is being released:
4. Check for any
`dependabot alerts <https://github.com/zhmcclient/python-zhmcclient/security/dependabot>`_.

If there are any dependabot alerts, fix them in a separate branch/PR.

Roll back the PR into any maintained stable branches.

5. Create a topic branch for the version that is being released:

.. code-block:: sh
git checkout ${BRANCH}
git pull
git checkout -b release_${MNU}
5. Update the change log:
6. Update the change log:

First make a dry-run to print the change log as it would be:

Expand All @@ -332,20 +339,20 @@ local clone of the zhmc-prometheus-exporter Git repo.
information from the change fragment files in the ``changes`` directory, and
will delete these change fragment files.

6. Update the authors:
7. Update the authors:

.. code-block:: sh
make authors
7. Commit your changes and push the topic branch to the remote repo:
8. Commit your changes and push the topic branch to the remote repo:

.. code-block:: sh
git commit -asm "Release ${MNU}"
git push --set-upstream origin release_${MNU}
8. On GitHub, create a Pull Request for branch ``release_M.N.U``.
9. On GitHub, create a Pull Request for branch ``release_M.N.U``.

Important: When creating Pull Requests, GitHub by default targets the
``master`` branch. When releasing based on a stable branch, you need to
Expand All @@ -360,19 +367,19 @@ local clone of the zhmc-prometheus-exporter Git repo.
tests for all defined environments, since it discovers by the branch name
that this is a PR for a release.

9. On GitHub, once the checks for that Pull Request have succeeded, merge the
10. On GitHub, once the checks for that Pull Request have succeeded, merge the
Pull Request (no review is needed). This automatically deletes the branch
on GitHub.

If the PR did not succeed, fix the issues.

10. On GitHub, close milestone ``M.N.U``.
11. On GitHub, close milestone ``M.N.U``.

Verify that the milestone has no open items anymore. If it does have open
items, investigate why and fix. If the milestone does not have open items
anymore, close the milestone.

11. Publish the package
12. Publish the package

.. code-block:: sh
Expand All @@ -388,7 +395,7 @@ local clone of the zhmc-prometheus-exporter Git repo.
Github, and finally creates a new stable branch on Github if the master
branch was released.

12. Verify the publishing
13. Verify the publishing

Wait for the "publish" workflow for the new release to have completed:
https://github.com/zhmcclient/zhmc-prometheus-exporter/actions/workflows/publish.yml
Expand Down

0 comments on commit 97a3ae3

Please sign in to comment.