From 39584cd9af52488226586c363bea7fba7cedb0ea Mon Sep 17 00:00:00 2001 From: Nicholas Rabinowitz Date: Mon, 18 Jun 2018 11:36:15 -0700 Subject: [PATCH] Fix npm distribution, add RELEASE doc --- .npmignore | 8 ++++++++ CHANGELOG.md | 6 ++++++ RELEASE.md | 14 ++++++++++++++ package.json | 2 +- 4 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 .npmignore create mode 100644 RELEASE.md diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..7d8fe54 --- /dev/null +++ b/.npmignore @@ -0,0 +1,8 @@ +*.log +*.tmp +coverage/ +h3c/ +node_modules/ +.* +build/ +test/ diff --git a/CHANGELOG.md b/CHANGELOG.md index 27d6bc6..7e727ba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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. diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..ec832c2 --- /dev/null +++ b/RELEASE.md @@ -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` diff --git a/package.json b/package.json index 9e78244..410dc0b 100644 --- a/package.json +++ b/package.json @@ -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 ", "contributors": [