Skip to content

Commit 9e10712

Browse files
authored
Added release step to check for Mend issues in internal repo (#2130)
Signed-off-by: Andreas Maier <maiera@de.ibm.com>
1 parent c5ad1fa commit 9e10712

2 files changed

Lines changed: 30 additions & 8 deletions

File tree

changes/noissue.mendscan.fix.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Added a step to the release instructions for checking Mend issues in the
2+
internal copy of the repo.

docs/development.rst

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -933,7 +933,27 @@ local clone of the python-zhmcclient Git repo.
933933

934934
Roll back the PR into any maintained stable branches.
935935

936-
4. Create and push the release branch (replace M,N,U accordingly):
936+
4. Check for any Mend issues
937+
938+
1. Push the ``master`` branch to the internal repo to bring it in sync with
939+
the public repo. This only makes a change for Mend if the pip
940+
requirements or constraints files have changed, but we do it always:
941+
942+
.. code-block:: sh
943+
944+
git checkout master
945+
git pull
946+
git push ibmfork master
947+
948+
2. Process any Mend issues in the internal repo.
949+
950+
If there are any Mend issues in the
951+
`internal issue tracker <https://github.ibm.com/zhmcclient/python-zhmcclient/issues>`_,
952+
fix them in a separate PR or PRs.
953+
954+
Roll back the PR(s) into any maintained stable branches.
955+
956+
5. Create and push the release branch (replace M,N,U accordingly):
937957

938958
.. code-block:: sh
939959
@@ -960,7 +980,7 @@ local clone of the python-zhmcclient Git repo.
960980
If this command fails, the fix can be committed to the release branch
961981
and the command above can be retried.
962982

963-
5. On GitHub, create a Pull Request for the release branch ``release_M.N.U``.
983+
6. On GitHub, create a Pull Request for the release branch ``release_M.N.U``.
964984

965985
Important: GitHub uses ``master`` as the default target branch. When
966986
releasing based on a stable branch, you need to change the target branch
@@ -975,18 +995,18 @@ local clone of the python-zhmcclient Git repo.
975995
tests for all defined environments, since it discovers by the branch name
976996
that this is a PR for a release.
977997

978-
6. On GitHub, once the checks for that Pull Request have succeeded, merge the
998+
7. On GitHub, once the checks for that Pull Request have succeeded, merge the
979999
Pull Request (no review is needed). This automatically deletes the branch
9801000
on GitHub.
9811001

9821002
If the PR did not succeed, fix the issues.
9831003

984-
7. On GitHub, close milestone ``M.N.U``.
1004+
8. On GitHub, close milestone ``M.N.U``.
9851005

9861006
Verify that the milestone has no open items anymore. If it does have open
9871007
items, investigate why and fix (probably step 1 was not performed).
9881008

989-
8. Publish the package (replace M,N,U accordingly):
1009+
9. Publish the package (replace M,N,U accordingly):
9901010

9911011
.. code-block:: sh
9921012
@@ -1008,7 +1028,7 @@ local clone of the python-zhmcclient Git repo.
10081028
GitHub, and finally creates a new stable branch on GitHub if the master
10091029
branch was released.
10101030

1011-
9. Verify the publishing
1031+
10. Verify the publishing
10121032

10131033
Wait for the "publish" workflow for the new release to have completed:
10141034
https://github.com/zhmcclient/python-zhmcclient/actions/workflows/publish.yml
@@ -1021,7 +1041,7 @@ local clone of the python-zhmcclient Git repo.
10211041
* Verify that the new version has a release on GitHub at
10221042
https://github.com/zhmcclient/python-zhmcclient/releases
10231043

1024-
10. Verify the documentation on ReadTheDocs
1044+
11. Verify the documentation on ReadTheDocs
10251045

10261046
ReadTheDocs automatically activates the new version and sets it as a
10271047
default version. Branches such as 'master' or 'stable' are no longer
@@ -1036,7 +1056,7 @@ local clone of the python-zhmcclient Git repo.
10361056
the URL for the new version. This verifies that it has been activated and
10371057
set as the default version.
10381058

1039-
11. Hide previous fix version on ReadTheDocs
1059+
12. Hide previous fix version on ReadTheDocs
10401060

10411061
When releasing a fix version != 0 (e.g. M.N.1), log on to
10421062
https://readthedocs.org/accounts/login/, go to

0 commit comments

Comments
 (0)