zcash-hackworks
/
bitcore-node-zcash
mirror of https://github.com/zcash-hackworks/bitcore-node-zcash.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #116 from kleetus/release_notes 

Added a note about the npm publish behavior.
This commit is contained in:
Braydon Fuller 2015-08-11 15:37:14 -04:00
parent 1027a77d6f 5cae32b439
commit 32819cac9a
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
RELEASE.md
View File

@ -17,19 +17,21 @@ To verify signatures, use the following PGP keys:
### How to Release ### How to Release
Ensure you've followed the instructions in the README.md for building the project from source. You will be using node-gyp to build the C++ bindings. A script will then upload the bindings to S3 for later use. You will also need credentials for BitPay's bitcore-node S3 bucket and be listed as an author for the bitcore-node's npm module. Ensure you've followed the instructions in the README.md for building the project from source. When building for any platform, be sure to keep in mind the minimum supported C and C++ system libraries and build from source using this library. Example, Ubuntu 12.04 has the earliest system library for Linux that we support, so it would be easiest to build the Linux artifact using this version. You will be using node-gyp to build the C++ bindings. A script will then upload the bindings to S3 for later use. You will also need credentials for BitPay's bitcore-node S3 bucket and be listed as an author for the bitcore-node's npm module.
- Create a file `.bitcore-node-upload.json` in your home directory - Create a file `.bitcore-node-upload.json` in your home directory
- The format of this file should be: - The format of this file should be:
```json ```json
{ {
"region": "us-east-1", "region": "us-west-2",
"accessKeyId": "xxx", "accessKeyId": "xxx",
"secretAccessKey": "yyy" "secretAccessKey": "yyy"
} }
``` ```
When publishing to npm, the .gitignore file is used to exclude files from the npm publishing process. Be sure that the bitcore-node directory has only the directories and files that you would like to publish to npm. You might need to run the commands below on each platform that you intend to publish (e.g. Mac and Linux).
To make a release, bump the version of the package.json: To make a release, bump the version of the package.json:
```bash ```bash
@ -48,3 +50,10 @@ And then update the version of the package.json for development (e.g. "0.3.2-dev
git commit -a -m "Bump development version to <version>" git commit -a -m "Bump development version to <version>"
git push upstream master git push upstream master
``` ```
Create a release tag and push it to the BitPay Github repo:
```bash
git tag <version>
git push upstream --tags
```