Skip to content

Commit

Permalink
Docs: Fixed instructions to release a version
Browse files Browse the repository at this point in the history
Details:

* Docs: Fixed instructions to release a version to cover for the case where
  the docs build does not show the new verison in the release notes.

Signed-off-by: Andreas Maier <[email protected]>
  • Loading branch information
andy-maier committed Jun 17, 2021
1 parent 3f50750 commit 905ee75
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/source/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,16 @@ local clone of the zhmc-ansible-modules Git repo.
git tag -f ${MNU}
git push -f --tags
* Wait for the docs workflow named "Release M.N.U" to complete, on
https://github.com/zhmcclient/zhmc-ansible-modules/actions/workflows/docs.yml,
and once it is complete, double check whether you see the new version
in the release notes at
https://zhmcclient.github.io/zhmc-ansible-modules/release_notes.html.

If you do not see the new release notes, the build was faster than the
pushing of the new tag, and this can be fixed by simply re-running
the docs workflow via the corresponding button in GitHub Actions.

11. Clean up the local repo:

.. code-block:: sh
Expand Down
3 changes: 3 additions & 0 deletions docs/source/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,9 @@ Released: 2021-06-17
wins. Since PRs are merged in the order earlier first, their docs build should
also finish first. (issue #417)

* Docs: Fixed instructions to release a version to cover for the case where
the docs build does not show the new verison in the release notes.

**Enhancements:**

* Docs: The idempotency of each module and possible limitations are now
Expand Down

0 comments on commit 905ee75

Please sign in to comment.