diff options
| author | Amjith Ramanujam <amjith.r@gmail.com> | 2022-03-30 16:54:46 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-30 16:54:46 -0700 |
| commit | 366c01bbb97fee96a8169629854af7c83d626c99 (patch) | |
| tree | 8a4321b98e8619d83f7d2eccba1875db12556812 | |
| parent | a878d2a4ba917d191e2fa0460e73f2bb44e3346e (diff) | |
| parent | 5ee4f89a3b8cbc33465312285851da67e8fba428 (diff) | |
Merge pull request #1327 from dbcli/j-bennet/update-readme-release
Improve release instructions
| -rw-r--r-- | DEVELOP.rst | 5 | ||||
| -rw-r--r-- | RELEASES.md | 15 |
2 files changed, 16 insertions, 4 deletions
diff --git a/DEVELOP.rst b/DEVELOP.rst index e262823d..0656905c 100644 --- a/DEVELOP.rst +++ b/DEVELOP.rst @@ -176,3 +176,8 @@ Coding Style ------------ ``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. diff --git a/RELEASES.md b/RELEASES.md index 37cf4d2e..526c260e 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`. |