summary refs log tree commit diff
path: root/scripts-dev/release.py
diff options
context:
space:
mode:
authorDavid Robertson <davidr@element.io>2023-10-24 14:27:34 +0100
committerDavid Robertson <davidr@element.io>2023-10-24 14:30:06 +0100
commit7f944314090810affa195b6815e2efb2640fab46 (patch)
tree3707e86da72905dbd3675d5f94d7fcea7502fb5a /scripts-dev/release.py
parentMerge branch 'master' into develop (diff)
downloadsynapse-7f944314090810affa195b6815e2efb2640fab46.tar.xz
Fix whitespace in help release script help message
Before (scripts-dev/release.py --help):

```
  Requirements:   - The dev dependencies be installed, which can be done via:

          pip install -e .[dev]

    - A checkout of the sytest repository at ../sytest

  Then to use:

      ./scripts-dev/release.py prepare

      # ... ask others to look at the changelog ...

      ./scripts-dev/release.py tag

      # wait for assets to build, either manually or with:     ./scripts-
      dev/release.py wait-for-actions

      ./scripts-dev/release.py publish

      ./scripts-dev/release.py upload

      ./scripts-dev/release.py merge-back

      # Optional: generate some nice links for the announcement     ./scripts-
      dev/release.py announce

```

After:

```
  Requirements:

    - The dev dependencies be installed, which can be done via:

          pip install -e .[dev]

    - A checkout of the sytest repository at ../sytest

  Then to use:

      ./scripts-dev/release.py prepare

      # ... ask others to look at the changelog ...

      ./scripts-dev/release.py tag

      # wait for assets to build, either manually or with:

      ./scripts-dev/release.py wait-for-actions

      ./scripts-dev/release.py publish

      ./scripts-dev/release.py upload

      ./scripts-dev/release.py merge-back

      # Optional: generate some nice links for the announcement

      ./scripts-dev/release.py announce
```
Diffstat (limited to '')
-rwxr-xr-xscripts-dev/release.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/scripts-dev/release.py b/scripts-dev/release.py
index 7508ae5096..bee8761182 100755
--- a/scripts-dev/release.py
+++ b/scripts-dev/release.py
@@ -58,6 +58,7 @@ def cli() -> None:
     """An interactive script to walk through the parts of creating a release.
 
     Requirements:
+
       - The dev dependencies be installed, which can be done via:
 
             pip install -e .[dev]
@@ -73,6 +74,7 @@ def cli() -> None:
         ./scripts-dev/release.py tag
 
         # wait for assets to build, either manually or with:
+
         ./scripts-dev/release.py wait-for-actions
 
         ./scripts-dev/release.py publish
@@ -82,6 +84,7 @@ def cli() -> None:
         ./scripts-dev/release.py merge-back
 
         # Optional: generate some nice links for the announcement
+
         ./scripts-dev/release.py announce
 
     Alternatively, `./scripts-dev/release.py full` will do all the above