Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restore formatting for numbered list in release steps #1215

Merged
merged 2 commits into from
Apr 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changes/1215.misc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The indentation and formatting for the release steps numbered list was restored.
64 changes: 32 additions & 32 deletions docs/how-to/internal/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,30 +16,30 @@ you can configure that checkout by running:

The procedure for cutting a new release is as follows:

1. Check the contents of the upstream repository's main branch:
#. Check the contents of the upstream repository's main branch:

.. code-block:: console
.. code-block:: console

$ git fetch upstream
$ git checkout --detach upstream/main
$ git fetch upstream
$ git checkout --detach upstream/main

Check that the HEAD of release now matches upstream/main.
Check that the HEAD of release now matches upstream/main.

2. Ensure that the release notes are up to date. Run:
#. Ensure that the release notes are up to date. Run:

.. code-block:: console
.. code-block:: console

$ tox -e towncrier -- --draft
$ tox -e towncrier -- --draft

to review the release notes that will be included, and then:
to review the release notes that will be included, and then:

.. code-block:: console
.. code-block:: console

$ tox -e towncrier
$ tox -e towncrier

to generate the updated release notes.
to generate the updated release notes.

3. Ensure that there is a version branch for the new Briefcase version in
#. Ensure that there is a version branch for the new Briefcase version in
every template that Briefcase will use at runtime:

* ``briefcase-template``
Expand All @@ -54,15 +54,15 @@ to generate the updated release notes.
* ``briefcase-android-gradle-template``
* ``briefcase-web-static-template``

4. Tag the release, and push the branch and tag upstream:
#. Tag the release, and push the branch and tag upstream:

.. code-block:: console
.. code-block:: console

$ git tag v1.2.3
$ git push upstream HEAD:main
$ git push upstream v1.2.3
$ git tag v1.2.3
$ git push upstream HEAD:main
$ git push upstream v1.2.3

5. Pushing the tag will start a workflow to create a draft release on GitHub.
#. Pushing the tag will start a workflow to create a draft release on GitHub.
You can `follow the progress of the workflow on GitHub
<https://github.com/beeware/briefcase/actions?query=workflow%3A%22Create+Release%22>`__;
once the workflow completes, there should be a new `draft release
Expand All @@ -88,33 +88,33 @@ to generate the updated release notes.
code change, delete the old tag, make the code change, and re-tag the
release.

6. Create a clean virtual environment, install the new release from Test PyPI, and
#. Create a clean virtual environment, install the new release from Test PyPI, and
perform any pre-release testing that may be appropriate:

.. code-block:: console
.. code-block:: console

$ python3 -m venv testvenv
$ . ./testvenv/bin/activate
(testvenv) $ pip install --extra-index-url https://test.pypi.org/simple/ briefcase==1.2.3
(testvenv) $ briefcase --version
briefcase 1.2.3
(testvenv) $ #... any other manual checks you want to perform ...
$ python3 -m venv testvenv
$ . ./testvenv/bin/activate
(testvenv) $ pip install --extra-index-url https://test.pypi.org/simple/ briefcase==1.2.3
(testvenv) $ briefcase --version
briefcase 1.2.3
(testvenv) $ #... any other manual checks you want to perform ...

7. Log into ReadTheDocs, visit the `Versions tab
#. Log into ReadTheDocs, visit the `Versions tab
<https://readthedocs.org/projects/briefcase/versions/>`__, and activate the
new version. Ensure that the build completes; if there's a problem, you
may need to correct the build configuration, roll back and re-tag the release.

8. Edit the GitHub release to add release notes. You can use the text generated
#. Edit the GitHub release to add release notes. You can use the text generated
by Towncrier, but you'll need to update the format to Markdown, rather than
ReST. If necessary, check the pre-release checkbox.

9. Double check everything, then click Publish. This will trigger a
#. Double check everything, then click Publish. This will trigger a
`publication workflow on GitHub
<https://github.com/beeware/briefcase/actions?query=workflow%3A%22Upload+Python+Package%22>`__.

10. Wait for the `package to appear on PyPI
<https://pypi.org/project/briefcase/>`__.
#. Wait for the `package to appear on PyPI
<https://pypi.org/project/briefcase/>`__.

Congratulations, you've just published a release!

Expand Down