mirror of
https://github.com/bigchaindb/js-bigchaindb-driver.git
synced 2024-11-24 19:10:12 +01:00
Merge pull request #293 from bigchaindb/add-release-process
Document the release process and update the "release-it" options
This commit is contained in:
Manolo
GitHub
commit
ea572804e3
@ -40,8 +40,9 @@ Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
- [BigchainDB Documentation](#bigchaindb-documentation)
|
||||
- [Speed Optimizations](#speed-optimizations)
|
||||
- [Development](#development)
|
||||
- [Release Process](#release-process)
|
||||
- [Authors](#authors)
|
||||
- [License](#license)
|
||||
- [Licenses](#licenses)
|
||||
|
||||
---
|
||||
|
||||
@ -185,6 +186,10 @@ After updating source files in `src/`, make sure to update the API documentation
|
||||
npm run doc
|
||||
```
|
||||
|
||||
## Release Process
|
||||
|
||||
See the file named [RELEASE_PROCESS.md](RELEASE_PROCESS.md).
|
||||
|
||||
## Authors
|
||||
|
||||
* inspired by [`js-bigchaindb-quickstart`](https://github.com/sohkai/js-bigchaindb-quickstart) of @sohkhai [thanks]
|
||||
|
||||
91
RELEASE_PROCESS.md
Normal file
91
RELEASE_PROCESS.md
Normal file
@ -0,0 +1,91 @@
|
||||
<!---
|
||||
Copyright BigchainDB GmbH and BigchainDB contributors
|
||||
SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
|
||||
Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
--->
|
||||
|
||||
# Our Release Process
|
||||
|
||||
## Notes
|
||||
|
||||
BigchainDB follows
|
||||
[the Python form of Semantic Versioning](https://packaging.python.org/tutorials/distributing-packages/#choosing-a-versioning-scheme)
|
||||
(i.e. MAJOR.MINOR.PATCH),
|
||||
which is almost identical
|
||||
to [regular semantic versioning](http://semver.org/), but there's no hyphen, e.g.
|
||||
|
||||
- `0.9.0` for a typical final release
|
||||
- `4.5.2a1` not `4.5.2-a1` for the first Alpha release
|
||||
- `3.4.5rc2` not `3.4.5-rc2` for Release Candidate 2
|
||||
|
||||
**Note:** For Git tags (which are used to identify releases on GitHub), we append a `v` in front.
|
||||
|
||||
We follow [BEP-1](https://github.com/bigchaindb/BEPs/tree/master/1), which is our variant of C4, the Collective Code Construction Contract, so a release is just a [tagged commit](https://git-scm.com/book/en/v2/Git-Basics-Tagging) on the `master` branch, i.e. a label for a particular Git commit.
|
||||
|
||||
## Steps
|
||||
|
||||
1. Make sure you have a recent version of node and npm.
|
||||
1. `npm install`
|
||||
1. Update all npm package dependencies, where possible. You might have to freeze some versions. Run all tests locally (`npm run test`) and make sure they pass. Make a pull request (to be merged into the `master` branch) and make sure all tests are passing there (in Travis). Merge the pull request.
|
||||
1. Make sure your local `master` branch is in sync with GitHub: `git checkout master` and `git pull`
|
||||
1. Do a test build:
|
||||
|
||||
`npm run build`
|
||||
|
||||
If that fails, then get it working.
|
||||
1. We use the [release-it](https://www.npmjs.com/package/release-it) package (from npm) to automate most of the release. Make sure you have a recent version.
|
||||
1. Login to npm using your npm credentials, so you can publish a new [bigchaindb-driver](https://www.npmjs.com/package/bigchaindb-driver) package there. (The npm account must haver permission to do so).
|
||||
|
||||
`npm login`
|
||||
|
||||
1. release-it needs a Github personal access token so it can interact with GitHub on your behalf. To get one, go to:
|
||||
|
||||
[https://github.com/settings/tokens](https://github.com/settings/tokens)
|
||||
|
||||
and then make that token available as an environment variable, e.g.
|
||||
|
||||
`export GITHUB_TOKEN="f941e0..."`
|
||||
|
||||
1. Do the release:
|
||||
|
||||
- For a patch release, do `npm run release`
|
||||
- For a minor release, do `npm run release-minor`
|
||||
- For a major release, do `npm run release-major`
|
||||
|
||||
If your npm account is using two-factor authentication,
|
||||
you will have to append a one-time password (OTP) like `--npm.otp=123456`.
|
||||
The above command will automatically do a bunch of things:
|
||||
|
||||
- bump the project version in `package.json`, then git commit and git push it.
|
||||
- create a new Git tag of the form `v{verson}`, e.g. `v1.2.3`
|
||||
- create a new [GitHub release](https://github.com/bigchaindb/js-bigchaindb-driver/releases).
|
||||
- publish a new npm release
|
||||
|
||||
To see all the arguments passed to `release-it`, search for "release" in [package.json](package.json). The arguments are documented in the [release-it GitHub repo](https://github.com/release-it/release-it).
|
||||
|
||||
1. Make sure everything worked as expected.
|
||||
|
||||
- Was the version number bumped properly in [package.json](package.json)?
|
||||
- Was a new Git tag created? See the [list of tags](https://github.com/bigchaindb/js-bigchaindb-driver/tags).
|
||||
- Was a new GitHub release created? See the [list of releases](https://github.com/bigchaindb/js-bigchaindb-driver/releases).
|
||||
- Was a new npm package published on npm? [Check on npmjs.com](https://www.npmjs.com/package/bigchaindb-driver).
|
||||
|
||||
1. You can edit the description of the GitHub release to add or remove details.
|
||||
|
||||
If the docs were updated since the last release, [login to readthedocs.org](https://readthedocs.org/accounts/login/) and go to the **BigchainDB JavaScript Driver** project, then:
|
||||
|
||||
1. Click on "Builds", select "latest" from the drop-down menu, then click the "Build Version:" button.
|
||||
1. Wait for the build of "latest" to finish. This can take a few minutes.
|
||||
1. Go to Admin --> Advanced Settings
|
||||
and make sure that "Default branch:" (i.e. what "latest" points to)
|
||||
is set to the new release's tag, e.g. `v0.9.1`.
|
||||
(It won't be an option if you didn't wait for the build of "latest" to finish.)
|
||||
Then scroll to the bottom and click "Save".
|
||||
1. Go to Admin --> Versions
|
||||
and under **Choose Active Versions**, do these things:
|
||||
|
||||
1. Make sure that the new version's tag is "Active" and "Public"
|
||||
1. Make sure the **stable** branch is _not_ active.
|
||||
1. Scroll to the bottom of the page and click "Save".
|
||||
|
||||
Congratulations, you have released a new version of the BigchainDB JavaScript Driver!
|
||||
@ -23,9 +23,9 @@
|
||||
"clean": "rimraf dist/bundle dist/node",
|
||||
"test": "npm run lint && nyc ava test/ && npm run thanks && npm run report-coverage",
|
||||
"thanks": "cowsay Hi, thanks for your interest in BigchainDB. We appreciate your contribution!",
|
||||
"release": "./node_modules/release-it/bin/release-it.js --src.tagName='v%s' --github.release --npm.publish --non-interactive",
|
||||
"release-minor": "./node_modules/release-it/bin/release-it.js minor --src.tagName='v%s' --github.release --npm.publish --non-interactive",
|
||||
"release-major": "./node_modules/release-it/bin/release-it.js major --src.tagName='v%s' --github.release --npm.publish --non-interactive",
|
||||
"release": "./node_modules/release-it/bin/release-it.js --git.tagName='v${version}' --github.release --npm.publish --non-interactive",
|
||||
"release-minor": "./node_modules/release-it/bin/release-it.js minor --git.tagName='v${version}' --github.release --npm.publish --non-interactive",
|
||||
"release-major": "./node_modules/release-it/bin/release-it.js major --git.tagName='v${version}' --github.release --npm.publish --non-interactive",
|
||||
"prepublishOnly": "npm run build",
|
||||
"report-coverage": "nyc report --reporter=lcov > coverage.lcov && codecov",
|
||||
"doc": "node ./node_modules/documentation/bin/documentation.js build src/index.js -f md -o API.md -g --markdown-toc"
|
||||
@ -58,7 +58,7 @@
|
||||
"husky": "^2.1.0",
|
||||
"lint-staged": "^8.0.0",
|
||||
"nyc": "^14.0.0",
|
||||
"release-it": "^10.4.4",
|
||||
"release-it": "^12.2.0",
|
||||
"rimraf": "^2.6.2",
|
||||
"sinon": "^7.3.2",
|
||||
"webpack": "^4.28.4",
|
||||
|
||||
Loading…
Reference in New Issue
Block a user