Skip to content
This repository was archived by the owner on Mar 8, 2024. It is now read-only.

Commit fa315b5

Browse files
author
Austin King
committed
fix: update release.md w/ removed content
1 parent 6aa0cc6 commit fa315b5

File tree

1 file changed

+22
-15
lines changed

1 file changed

+22
-15
lines changed

release.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,4 @@
1-
# Usage
2-
3-
## NPM Scripts
4-
5-
### bump
6-
7-
To compare Git tag & NPM version, and bump the NPM version, run:
8-
9-
`npm run bump <increment>` ( where `<increment>` = `major`, `minor`, or `patch` )
10-
11-
### release
12-
13-
To create a release draft from the command line, run:
14-
15-
`npm run release` ( you may need to setup `hub` locally )
1+
# PayID Server Release Process
162

173
## Cutting a Release
184

@@ -24,18 +10,39 @@ The full process for cutting a release is as follows:
2410

2511
1. Checkout a new branch:
2612
`git checkout -b v1.4-release`
13+
2714
2. Run the bump script locally on that branch (the working directory must be clean):
2815
`npm run bump minor`
16+
2917
3. Commit the changes, push up the branch, and open a PR:
3018
`git commit package.json package-lock.json`
3119
`git push --set-upstream origin HEAD`
3220
`hub pull-request`
21+
3322
4. Once the PR is merged, checkout the `master` branch:
3423
`git checkout master`
24+
3525
5. Make a new Git tag that matches the new NPM version (make sure it is associated with the right commit SHA):
3626
`git tag -a v1.4 f34dcd3`
27+
3728
6. Push up the tag from `master`:
3829
`git push origin v1.4`
30+
3931
7. Cut a release draft:
4032
`npm run release`
33+
4134
8. Fill in the release details and publish it in GitHub.
35+
36+
## NPM Scripts Reference
37+
38+
### bump
39+
40+
To compare Git tag & NPM version, and bump the NPM version, run:
41+
42+
`npm run bump <increment>` ( where `<increment>` = `major`, `minor`, or `patch` )
43+
44+
### release
45+
46+
To create a release draft from the command line, run:
47+
48+
`npm run release` ( you may need to setup `hub` locally )

0 commit comments

Comments
 (0)