@@ -11,49 +11,39 @@ For you to follow along according to these instructions, you need:
11
11
12
12
## Steps to make a release
13
13
14
- 1 . Checkout main and make sure it is up to date.
14
+ 1 . Create a PR updating ` docs/source/changelog.md ` with [ github-activity] and
15
+ continue only when its merged.
15
16
16
17
``` shell
17
- ORIGIN=${ORIGIN:- origin} # set to the canonical remote, e.g. 'upstream' if 'origin' is not the official repo
18
- git checkout main
19
- git fetch $ORIGIN main
20
- # WARNING! These next commands discard any changes or uncommitted files!
21
- git reset --hard $ORIGIN /main
22
- git clean -xfd
18
+ pip install github-activity
19
+
20
+ github-activity --heading-level=3 jupyterhub/traefik-proxy
23
21
```
24
22
25
- 1 . Update [ changelog.md] ( docs/source/changelog.md ) and add it to
26
- the working tree.
23
+ 1 . Checkout main and make sure it is up to date.
27
24
28
25
``` shell
29
- git add traefik-proxy/docs/source/changelog.md
26
+ git checkout main
27
+ git fetch origin main
28
+ git reset --hard origin/main
30
29
```
31
30
32
- Tip: Identifying the changes can be made easier with the help of the
33
- [ choldgraf/github-activity] ( https://github.com/choldgraf/github-activity )
34
- utility.
35
-
36
- 1 . Set a shell variable to be the new version you want to release.
37
- The actual project version will be detected automatically by versioneer
38
- from git tags inspection. The versioneer script will be run by setup.py
39
- when packaging is occurring.
31
+ 1 . Update the version, make commits, and push a git tag with ` tbump ` .
40
32
41
33
``` shell
42
- VERSION=... # e.g. 1.2.3
43
- git commit -m " release $VERSION "
34
+ pip install tbump
35
+ tbump --dry-run ${VERSION}
36
+
37
+ tbump ${VERSION}
44
38
```
45
39
46
- Tip: You can get the current project version by checking the [ latest
47
- tag on GitHub] ( https://github.com/jupyterhub/traefik-proxy/tags ) .
40
+ Following this, the [ CI system] will build and publish a release.
48
41
49
- 1 . Create a git tag for the release commit and push them both.
42
+ 1 . Reset the version back to dev, e.g. ` 2.1.0.dev ` after releasing ` 2.0.0 `
50
43
51
44
``` shell
52
- git tag -a $VERSION -m " release $VERSION "
53
-
54
- # then verify you tagged the right commit
55
- git log
56
-
57
- # then push it
58
- git push $ORIGIN --atomic --follow-tags
45
+ tbump --no-tag ${NEXT_VERSION} .dev
59
46
```
47
+
48
+ [ ci system ] : https://github.com/jupyterhub/traefik-proxy/actions
49
+ [ github-activity ] : https://github.com/executablebooks/github-activity
0 commit comments