@@ -13,69 +13,61 @@ meet the prerequisites:
13
13
14
14
- To have push rights to the [ configurable-http-proxy GitHub
15
15
repository] ( https://github.com/jupyterhub/configurable-http-proxy ) .
16
- - To have [ ` bump2version ` ] ( https://github.com/c4urself/bump2version ) installed
17
- (` pip install bump2version ` ).
16
+ - To have [ Node.js] ( https://nodejs.org ) installed.
18
17
19
18
## Steps to make a release
20
19
21
20
1 . Update [ CHANGELOG.md] ( CHANGELOG.md ) if it is not up to date, and verify
22
21
[ README.md] ( README.md ) has an updated output of running ` --help ` . Make a PR
23
22
to review the CHANGELOG notes.
24
23
25
- 1 . Once the changelog is up to date, checkout main and make sure it is up to
24
+ 1 . Once the changelog is up to date, checkout the main branch and make sure it is up to
26
25
date and clean.
27
26
28
27
``` bash
29
28
ORIGIN=${ORIGIN:- origin} # set to the canonical remote, e.g. 'upstream' if 'origin' is not the official repo
30
29
git checkout main
31
- git fetch $ORIGIN main
32
- git reset --hard $ORIGIN /main
33
- # WARNING! This next command deletes any untracked files in the repo
34
- git clean -xfd
30
+ git branch --set-upstream-to=$ORIGIN /main main
31
+ git pull
35
32
```
36
33
37
- 1 . Update the version with ` bump2version ` to not include the -dev suffix and let
38
- it make a git commit and tag as well for us.
34
+ 1 . Update the version with [ ` npm version ` ] ( https://docs.npmjs.com/cli/v6/commands/npm-version )
35
+ and let it make a git commit and tag as well for us.
39
36
40
37
``` bash
41
- # optionally first bump a minor or major version, but
42
- # don't bump the patch version, that's already done.
43
- # bump2version --no-commit minor
44
- # bump2version --no-commit major
45
- bump2version --tag release
38
+ # specify the new version here,
39
+ # which should already have been chosen when updating the changelog.
40
+ npm version 1.2.3
46
41
47
42
# verify changes
48
43
git diff HEAD~1
49
44
```
50
45
51
- 1 . Reset the version to the next development version with ` bump2version ` .
46
+ 1 . Reset the version to the next development version with ` npm version ` ,
47
+ without creating a tag:
52
48
53
49
``` bash
54
- bump2version --no-tag patch
50
+ npm version --no-git- tag-version prerelease --preid=dev
55
51
56
52
# verify changes
57
53
git diff HEAD~1
58
54
```
59
55
60
- 1 . Push your release related commits to main along with the annotated tags
61
- referencing commits on the main branch.
56
+ 1 . Push your new tag and commits to GitHub.
62
57
63
- ```
58
+ ``` bash
64
59
git push --follow-tags $ORIGIN main
65
60
```
66
61
67
- 1 . Visit [ GitHub: create new
68
- release] ( https://github.com/jupyterhub/configurable-http-proxy/releases/new )
69
- and reference your tag.
70
-
71
- This will trigger a workflow to publish the NPM package.
72
-
73
62
1 . Verify [ the automated
74
63
workflow] ( https://github.com/jupyterhub/configurable-http-proxy/actions?query=workflow%3A%22Publish+to+npm%22 )
75
64
succeeded.
76
65
77
66
## Manual release to npm
78
67
68
+ A manual release should not generally be required,
69
+ but might be needed in the event of a problem in the automated publishing workflow.
70
+
79
71
1 . Verify you are a collaborator of the [ npmjs
80
72
project] ( https://www.npmjs.com/package/configurable-http-proxy ) .
81
73
0 commit comments