Skip to content

Commit 5cc1839

Browse files
committed
Update the release documentation
1 parent e303400 commit 5cc1839

File tree

1 file changed

+24
-28
lines changed

1 file changed

+24
-28
lines changed

Diff for: RELEASE.md

+24-28
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,31 @@
11
# Release HOW TO
22

3-
## Creating the pull request
3+
## Git
44

5-
* Edit the following files and change the version :
6-
+ `pgactivity/__init__.py`
7-
* Prepare the release notes using the [commit
8-
list](https://github.com/dalibo/pg_activity/commits/master)
9-
* Submit the PR with the release notes in the description.
5+
* Bump version in `pgactivity/__init__.py`, rebuild the man page
6+
* Commit these changes on the `master` branch
7+
* Create an annotated (and possibly signed) tag, as
8+
`git commit -a [-s] -m 'pg_activity 1.6.0' v1.6.0`
9+
* Push with `--follow-tags`
1010

11-
Example commit message from [release
12-
1.6.0](https://github.com/dalibo/pg_activity/releases/tag/v1.6.0)
11+
## PyPI package
1312

14-
```
13+
This requires no special action as, upon push of a tag on GitHub, the "publish"
14+
workflow will build the Python package and upload to PyPI.
15+
16+
## GitHub release
17+
18+
Prepare the release notes, for instance from closed issues, merged pull
19+
requests, or directly the git history (e.g. `git log $(git describe --tags
20+
--abbrev=0).. --format=%s --reverse` to get commits from the previous tag).
21+
22+
Use this to *draft a new release* from [release page][], choosing the tag just
23+
pushed.
24+
25+
[release page]: https://github.com/dalibo/pg_activity/releases
26+
27+
See for example [release 1.6.0](v1.6.0):
28+
```
1529
Change log:
1630
1731
* Add the --min-duration flag to only show laggy queries (@kmoppel)
@@ -33,26 +47,10 @@ Bug fixes:
3347
@julmon, report: @kmoppel)
3448
* Fix #113: Do not try to display query duration if not there (fix: @julmon,
3549
report: @pmpetit)
36-
3750
```
3851

39-
## Creating the release on github
52+
[v1.6.0]: https://github.com/dalibo/pg_activity/releases/tag/v1.6.0
4053

41-
Once the PR is merged, the release can be created.
42-
43-
Choose the option "Draft a new release" from the [release
44-
page](https://github.com/dalibo/pg_activity/releases) :
45-
46-
* Input a tag version (eg, v1.6.0) ;
47-
* Leave the target as is (master) ;
48-
* Input the release title (eg, pg_activity 1.6.0) ;
49-
* Add the release notes in the release description ;
50-
* Then press `publish release`.
51-
52-
## Create the release on pypi
53-
54-
Upon push of a tag to GitHub, the "publish" workflow will build the Python
55-
package and upload to PyPI.
5654

5755
## Send a mail to pgsql-announce
5856

@@ -74,5 +72,3 @@ This release adds the following features :
7472
7573
The full release notes can be read here :
7674
https://github.com/dalibo/pg_activity/releases/tag/v1.6.0
77-
```
78-

0 commit comments

Comments
 (0)