1
0
Fork 0

Explicitly point to release guide.

This commit is contained in:
Irina Truong 2022-03-30 16:41:44 -07:00
parent 02134daad7
commit 5ee4f89a3b
2 changed files with 16 additions and 4 deletions

View File

@ -176,3 +176,8 @@ Coding Style
------------ ------------
``pgcli`` uses `black <https://github.com/ambv/black>`_ to format the source code. Make sure to install black. ``pgcli`` uses `black <https://github.com/ambv/black>`_ to format the source code. Make sure to install black.
Releases
--------
If you're the person responsible for releasing `pgcli`, `this guide <https://github.com/dbcli/pgcli/blob/main/RELEASES.md>`_ is for you.

View File

@ -1,11 +1,9 @@
Releasing pgcli 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 > python release.py --help
Usage: release.py [options] Usage: release.py [options]
@ -15,3 +13,12 @@ Options:
will be skipped. will be skipped.
-d, --dry-run Print out, but not actually run any steps. -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`.