Skip to content

Commit 83dd702

Browse files
authored
Fix #59: Clarify steps when creating a release (#60)
1 parent 279fe42 commit 83dd702

3 files changed

Lines changed: 15 additions & 4 deletions

File tree

changelog.d/59.doc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Clarify some steps when creating a release.

docs/source/developer/create-release.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,22 @@
33
Creating a New Release
44
======================
55

6-
To create a new release, follow these steps:
6+
When you are ready to release a new version of the project, start with creating a new release branch. There you bump the version, build the changelog, and adjust minor things like the documentation. Avoid commiting changes that introduces new features or add breaking changes.
7+
8+
Follow these steps:
79

810
#. Ensure that you have the latest changes from the main branch of the repository.
911
#. Create a new branch named ``release/<VERSION>``, where ``<VERSION>`` is the version number you are releasing (e.g., ``release/1.0.0``).
1012
#. :ref:`Bump the version <bump-version>`.
1113
#. :ref:`Update the project <update-project>`.
1214
#. :ref:`Build the changelog <build-changelog>`.
15+
#. In your current branch, push the branch to the remote repository:
16+
17+
.. code-block:: console
18+
19+
git push origin HEAD
20+
1321
#. Wait for the CI to pass. If it fails, fix the issues and commit again.
1422
#. If the CI passes, (squash-)merge your release branch into the main branch.
1523
The GitHub Action workflow will automatically create a new release based on the name of the release branch.
16-
#. Find the release in the GitHub repository under the |gh_release| section.
24+
#. Find the release in the GitHub repository under the |gh_release| section.

docs/source/reference/_autoapi/docbuild/cli/index.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ docbuild.cli
99

1010
* :class:`~docbuild.cli.cmd_build`: Build the documentation.
1111
* :class:`~docbuild.cli.cmd_c14n`: Canonicalize the documentation.
12+
* :class:`~docbuild.cli.cmd_config`: Configuration management for docbuild CLI commands.
1213
* :class:`~docbuild.cli.cmd_cli`: Main CLI entry point for docbuild.
13-
* :class:`~docbuild.cli.config`: Configuration management for docbuild CLI commands.
14+
* :class:`~docbuild.cli.cmd_metadata`: Metadata management for docbuild.
15+
* :class:`~docbuild.cli.cmd_validate`: Validate the documentation.
1416

1517
Additional modules:
1618
* :class:`~docbuild.cli.context`: Context for the docbuild CLI commands.
@@ -27,10 +29,10 @@ Submodules
2729
/reference/_autoapi/docbuild/cli/cmd_build/index
2830
/reference/_autoapi/docbuild/cli/cmd_c14n/index
2931
/reference/_autoapi/docbuild/cli/cmd_cli/index
32+
/reference/_autoapi/docbuild/cli/cmd_config/index
3033
/reference/_autoapi/docbuild/cli/cmd_metadata/index
3134
/reference/_autoapi/docbuild/cli/cmd_repo/index
3235
/reference/_autoapi/docbuild/cli/cmd_validate/index
33-
/reference/_autoapi/docbuild/cli/config/index
3436
/reference/_autoapi/docbuild/cli/context/index
3537
/reference/_autoapi/docbuild/cli/defaults/index
3638

0 commit comments

Comments
 (0)