From 5556b491c1a6775a6592316067d12e35a743d45c Mon Sep 17 00:00:00 2001 From: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> Date: Fri, 24 Oct 2025 11:19:44 +0200 Subject: [PATCH] Spruce up generated announcement text in the release script (#19089) --- changelog.d/19089.misc | 1 + scripts-dev/release.py | 21 +++++++++++++++++---- 2 files changed, 18 insertions(+), 4 deletions(-) create mode 100644 changelog.d/19089.misc diff --git a/changelog.d/19089.misc b/changelog.d/19089.misc new file mode 100644 index 0000000000..81c8775fd0 --- /dev/null +++ b/changelog.d/19089.misc @@ -0,0 +1 @@ +Update the release script's generated announcement text to include a title and extra text for RC's. \ No newline at end of file diff --git a/scripts-dev/release.py b/scripts-dev/release.py index 16f1fc5f2a..c20237eab8 100755 --- a/scripts-dev/release.py +++ b/scripts-dev/release.py @@ -715,18 +715,31 @@ def _announce() -> None: current_version = get_package_version() tag_name = f"v{current_version}" + is_rc = "rc" in tag_name + + release_text = f""" +### Synapse {current_version} {"๐Ÿงช" if is_rc else "๐Ÿš€"} - click.echo( - f""" Hi everyone. Synapse {current_version} has just been released. +""" + if "rc" in tag_name: + release_text += ( + "\nThis is a release candidate. Please help us test it out " + "before the final release by deploying it to non-production environments, " + "and reporting any issues you find to " + "[the issue tracker](https://github.com/element-hq/synapse/issues). Thanks!\n" + ) + + release_text += f""" [notes](https://github.com/element-hq/synapse/releases/tag/{tag_name}) | \ [docker](https://hub.docker.com/r/matrixdotorg/synapse/tags?name={tag_name}) | \ [debs](https://packages.matrix.org/debian/) | \ [pypi](https://pypi.org/project/matrix-synapse/{current_version}/)""" - ) - if "rc" in tag_name: + click.echo(release_text) + + if is_rc: click.echo( """ Announce the RC in