Skip to content

Commit

Permalink
Documented Mend & Dependabot review when releasing
Browse files Browse the repository at this point in the history
Signed-off-by: Andreas Maier <maiera@de.ibm.com>
  • Loading branch information
andy-maier committed May 14, 2024
1 parent 26c412b commit b16d6e4
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions docs/source/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -324,14 +324,24 @@ local clone of the zhmc-ansible-modules Git repo.
If the safety run fails, you need to fix the safety issues that are
reported.

7. Commit your changes and push the topic branch to the remote repo:
7. Review the result of the latest Mend scan in
`this Box folder <https://ibm.ent.box.com/folder/190964336381?s=070khx70ijj3ime3k4yfx7r7cjb2xx0k>`_.

If the Mend scan shows any issues, fix them.

8. Check for any
`dependabot issues <https://github.com/zhmcclient/zhmc-ansible-modules/security/dependabot>`_.

If there are any dependebot issues, fix them.

9. 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``.
10. 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 @@ -341,18 +351,18 @@ local clone of the zhmc-ansible-modules 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
11. 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``.
12. 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.

11. Publish the collection to Ansible Galaxy
13. Publish the collection to Ansible Galaxy

.. code-block:: sh
Expand All @@ -368,7 +378,7 @@ local clone of the zhmc-ansible-modules Git repo.
it on Github, and finally creates a new stable branch on Github if the master
branch was released.

12. Verify the publishing
14. Verify the publishing

* Verify that the new version is available on Ansible Galaxy at
https://galaxy.ansible.com/ibm/ibm_zhmc/
Expand All @@ -383,7 +393,7 @@ local clone of the zhmc-ansible-modules Git repo.
* Verify that the new version has documentation on Github pages at
https://zhmcclient.github.io/zhmc-ansible-modules/release_notes.html

13. Publish the collection to Ansible AutomationHub
15. Publish the collection to Ansible AutomationHub

This needs to be done in addition to the prior publish step, and it
has not successfully been automated as of today.
Expand Down

0 comments on commit b16d6e4

Please sign in to comment.