From b16d6e44e78cfbf87503304cb56de47b66f7bfa7 Mon Sep 17 00:00:00 2001 From: Andreas Maier Date: Tue, 14 May 2024 10:52:01 +0200 Subject: [PATCH] Documented Mend & Dependabot review when releasing Signed-off-by: Andreas Maier --- docs/source/development.rst | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/docs/source/development.rst b/docs/source/development.rst index 676fa865f..39ad2f241 100644 --- a/docs/source/development.rst +++ b/docs/source/development.rst @@ -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 `_. + + If the Mend scan shows any issues, fix them. + +8. Check for any + `dependabot issues `_. + + 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 @@ -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 @@ -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/ @@ -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.