Skip to content

Commit 31cad29

Browse files
committed
Added release step to check for Mend issues in internal repo
Signed-off-by: Andreas Maier <maiera@de.ibm.com>
1 parent f333c40 commit 31cad29

2 files changed

Lines changed: 26 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: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -933,7 +933,23 @@ 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+
This can only be done using the IBM internal copy of the zhmcclient repo.
939+
940+
1. Push the branch that you are releasing (i.e. ``master`` or ``stable_M.N``)
941+
to the internal repo to bring it in sync with the public repo. This only
942+
makes a change for Mend if the pip requirements or constraints files
943+
have changed, but we do it always.
944+
945+
2. Process any Mend issues in the internal repo.
946+
947+
If there are any Mend issues in the issue tracker of the internal repo,
948+
fox them in a separate PR.
949+
950+
Roll back the PR into any maintained stable branches.
951+
952+
5. Create and push the release branch (replace M,N,U accordingly):
937953

938954
.. code-block:: sh
939955
@@ -960,7 +976,7 @@ local clone of the python-zhmcclient Git repo.
960976
If this command fails, the fix can be committed to the release branch
961977
and the command above can be retried.
962978

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

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

978-
6. On GitHub, once the checks for that Pull Request have succeeded, merge the
994+
7. On GitHub, once the checks for that Pull Request have succeeded, merge the
979995
Pull Request (no review is needed). This automatically deletes the branch
980996
on GitHub.
981997

982998
If the PR did not succeed, fix the issues.
983999

984-
7. On GitHub, close milestone ``M.N.U``.
1000+
8. On GitHub, close milestone ``M.N.U``.
9851001

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

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

9911007
.. code-block:: sh
9921008
@@ -1008,7 +1024,7 @@ local clone of the python-zhmcclient Git repo.
10081024
GitHub, and finally creates a new stable branch on GitHub if the master
10091025
branch was released.
10101026

1011-
9. Verify the publishing
1027+
10. Verify the publishing
10121028

10131029
Wait for the "publish" workflow for the new release to have completed:
10141030
https://github.com/zhmcclient/python-zhmcclient/actions/workflows/publish.yml
@@ -1021,7 +1037,7 @@ local clone of the python-zhmcclient Git repo.
10211037
* Verify that the new version has a release on GitHub at
10221038
https://github.com/zhmcclient/python-zhmcclient/releases
10231039

1024-
10. Verify the documentation on ReadTheDocs
1040+
11. Verify the documentation on ReadTheDocs
10251041

10261042
ReadTheDocs automatically activates the new version and sets it as a
10271043
default version. Branches such as 'master' or 'stable' are no longer
@@ -1036,7 +1052,7 @@ local clone of the python-zhmcclient Git repo.
10361052
the URL for the new version. This verifies that it has been activated and
10371053
set as the default version.
10381054

1039-
11. Hide previous fix version on ReadTheDocs
1055+
12. Hide previous fix version on ReadTheDocs
10401056

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

0 commit comments

Comments
 (0)