summaryrefslogtreecommitdiffstats
path: root/RELEASES.md
diff options
context:
space:
mode:
Diffstat (limited to 'RELEASES.md')
-rw-r--r--RELEASES.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/RELEASES.md b/RELEASES.md
new file mode 100644
index 0000000..37cf4d2
--- /dev/null
+++ b/RELEASES.md
@@ -0,0 +1,17 @@
+Releasing pgcli
+---------------
+
+We have a script called `release.py` to automate the process.
+
+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.
+
+```
+> python release.py --help
+Usage: release.py [options]
+
+Options:
+ -h, --help show this help message and exit
+ -c, --confirm-steps Confirm every step. If the step is not confirmed, it
+ will be skipped.
+ -d, --dry-run Print out, but not actually run any steps.
+```