Skip to content

Commit

Permalink
Merge pull request #2 from nrabinowitz/npm-publishing
Browse files Browse the repository at this point in the history
Fix npm distribution, add RELEASE doc
  • Loading branch information
nrabinowitz authored Jun 18, 2018
2 parents c6b7e29 + 39584cd commit 35fb3ea
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 1 deletion.
8 changes: 8 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
*.log
*.tmp
coverage/
h3c/
node_modules/
.*
build/
test/
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

All notable changes to this project will be documented in this file. This library adheres to a versioning policy described in [the README](./README.md#versioning). The public API of this library consists of the functions exported in [h3core.js](./lib/h3core.js).

## [Unreleased]

## [3.0.1] - 2018-06-18
### Fixed
- Fixed npm distribution

## [3.0.0] - 2018-06-18
### Added
- First public release.
14 changes: 14 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Release Process

Please note the [versioning guidelines](./README.md#versioning).

1. Create a PR "Preparing for release X.Y.Z" against master branch
* Update `package.json` version to `X.Y.Z`
* Alter CHANGELOG.md from `[Unreleased]` to `[X.Y.Z] YYYY-MM-DD`

2. Create a release "Release X.Y.Z" on Github
* Create Tag `vX.Y.Z`
* Copy CHANGELOG.md into the release notes

3. Publish to NPM
* `npm publish`
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "h3-js",
"version": "3.0.0",
"version": "3.0.1",
"description": "Emscripten transpiled libh3 'bindings' for Node/Web JS",
"author": "David Ellis <[email protected]>",
"contributors": [
Expand Down

0 comments on commit 35fb3ea

Please sign in to comment.