1
1
# Release HOW TO
2
2
3
- ## Creating the pull request
3
+ ## Git
4
4
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 `
10
10
11
- Example commit message from [ release
12
- 1.6.0] ( https://github.com/dalibo/pg_activity/releases/tag/v1.6.0 )
11
+ ## PyPI package
13
12
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
+ ```
15
29
Change log:
16
30
17
31
* Add the --min-duration flag to only show laggy queries (@kmoppel)
@@ -33,26 +47,10 @@ Bug fixes:
33
47
@julmon, report: @kmoppel)
34
48
* Fix #113: Do not try to display query duration if not there (fix: @julmon,
35
49
report: @pmpetit)
36
-
37
50
```
38
51
39
- ## Creating the release on github
52
+ [ v1.6.0 ] : https:// github.com/dalibo/pg_activity/releases/tag/v1.6.0
40
53
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.
56
54
57
55
## Send a mail to pgsql-announce
58
56
@@ -74,5 +72,3 @@ This release adds the following features :
74
72
75
73
The full release notes can be read here :
76
74
https://github.com/dalibo/pg_activity/releases/tag/v1.6.0
77
- ```
78
-
0 commit comments