summaryrefslogtreecommitdiffstats
path: root/RELEASES.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--RELEASES.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/RELEASES.md b/RELEASES.md
index 37cf4d2..526c260 100644
--- a/RELEASES.md
+++ b/RELEASES.md
@@ -1,11 +1,9 @@
Releasing pgcli
---------------
-We have a script called `release.py` to automate the process.
+You have been made the maintainer of `pgcli`? Congratulations! We have a release script to help you:
-The script can be run with `-c` to confirm or skip steps. There's also a `--dry-run` option that only prints out the steps.
-
-```
+```sh
> python release.py --help
Usage: release.py [options]
@@ -15,3 +13,12 @@ Options:
will be skipped.
-d, --dry-run Print out, but not actually run any steps.
```
+
+The script can be run with `-c` to confirm or skip steps. There's also a `--dry-run` option that only prints out the steps.
+
+To release a new version of the package:
+
+* Create and merge a PR to bump the version in the changelog ([example PR](https://github.com/dbcli/pgcli/pull/1325)).
+* Pull `main` and bump the version number inside `pgcli/__init__.py`. Do not check in - the release script will do that.
+* Make sure you have the dev requirements installed: `pip install -r requirements-dev.txt -U --upgrade-strategy only-if-needed`.
+* Finally, run the release script: `python release.py`.