From cf59b9e327c713d30e9d7fe314ad32647b806a47 Mon Sep 17 00:00:00 2001 From: Mario Lenz Date: Sat, 1 Jun 2024 20:03:02 +0200 Subject: [PATCH] Improve Automated Release Process documentation (#411) * 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
  • . * Move antsibull installation to a separate point. --------- Co-authored-by: Maxwell G Co-authored-by: Felix Fontein --- docs/automated-process.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/automated-process.md b/docs/automated-process.md index bf222d4457..71fcf26b19 100644 --- a/docs/automated-process.md +++ b/docs/automated-process.md @@ -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.