Skip to content

Commit

Permalink
Improve Automated Release Process documentation (#411)
Browse files Browse the repository at this point in the history
* Improve Automated Release Process documentation

* docs automated-process: fix indentation for mkdocs

python-markdown has stricter syntax rules than Github's markdown parser does.
Four-space indentation is needed to make sure all the paragraphs are nested
under the <li>.

* Move antsibull installation to a separate point.

---------

Co-authored-by: Maxwell G <maxwell@gtmx.me>
Co-authored-by: Felix Fontein <felix@fontein.de>
  • Loading branch information
3 people authored Jun 1, 2024
1 parent bf446fb commit cf59b9e
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions docs/automated-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,26 @@ release process. The automated processes uses GitHub Actions to automate the
branches down to the ansible-core version that is included in the Ansible
release.

5. Announce the release on the Forum, Matrix, and the mailing list by running
the following command in the `${MAJOR_VERSION}` directory of the
5. Make sure that you have installed [`antsibull`](https://pypi.org/project/antsibull/)
and a supported clipboard library. You can do that like this:

```
pip install antsibull[clipboard]
```

6. Then announce the release on the Forum, the mailing list and Matrix by
running the following command in the `${MAJOR_VERSION}` directory of the
`ansible-build-data` checkout:

```
antsibull-build announcements --send --data-dir . ${VERSION}
```

This will open your default browser and email client to do the announcement
on the forum and the mailing list. It will also tell you where to announce
this on Matrix, ask for the URL of the forum thread and create a suitable
text in your clipboard that you can copy to Matrix.

[^1]: This group is configured as "Required reviewers" for the "Configure pypi"
build environment in GitHub Actions of the `ansible-build-data` repository.

Expand Down

0 comments on commit cf59b9e

Please sign in to comment.