Merge pull request #352 from uuidjs/prepare-for-alpha-release

Prepare for canary release
uuidjs · Jan 21, 2020 · 380fe28 · 380fe28
2 parents 172d43d + 53ca9d4
commit 380fe28
Show file tree

Hide file tree

Showing 21 changed files with 3,183 additions and 1,720 deletions.
diff --git a/.local/README.md b/.local/README.md
@@ -0,0 +1,9 @@
+# Local Fake Module for Testing
+
+This is a local fake module for use in the [examples](../examples) and browser tests (that are
+based on the examples) where we reference the `uuid` module with a local `file:` path in the
+respective `package.json` files.
+
+We must ensure that the local module does not contain locally installed dev dependencies in a
+`node_modules` hence this "fake module" that just consists of symbolic links and imitates the final
+contents of the npm tarball.
diff --git a/.local/dist b/.local/dist
@@ -0,0 +1 @@
+../dist
diff --git a/.local/package.json b/.local/package.json
@@ -0,0 +1 @@
+../package.json
diff --git a/.npmignore b/.npmignore
diff --git a/.npmrc b/.npmrc
@@ -1,2 +1,2 @@
 tag-version-prefix="v"
-save-prefix="~"
+save-prefix=""
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,61 +2,62 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-### [3.3.3](https://github.com/kelektiv/node-uuid/compare/v3.3.2...v3.3.3) (2019-08-19)
+## [3.4.0](https://github.com/uuidjs/uuid/compare/v3.3.3...v3.4.0) (2020-01-16)
 
-<a name="3.3.2"></a>
+### Features
 
-## [3.3.2](https://github.com/kelektiv/node-uuid/compare/v3.3.1...v3.3.2) (2018-06-28)
+- rename repository to github:uuidjs/uuid ([#351](https://github.com/uuidjs/uuid/issues/351)) ([e2d7314](https://github.com/uuidjs/uuid/commit/e2d7314)), closes [#338](https://github.com/uuidjs/uuid/issues/338)
 
-### Bug Fixes
+## [3.3.3](https://github.com/uuidjs/uuid/compare/v3.3.2...v3.3.3) (2019-08-19)
 
-- typo ([305d877](https://github.com/kelektiv/node-uuid/commit/305d877))
+### Bug Fixes
 
-<a name="3.3.1"></a>
+- no longer run ci tests on node v4
+- upgrade dependencies
 
-## [3.3.1](https://github.com/kelektiv/node-uuid/compare/v3.3.0...v3.3.1) (2018-06-28)
+## [3.3.2](https://github.com/uuidjs/uuid/compare/v3.3.1...v3.3.2) (2018-06-28)
 
 ### Bug Fixes
 
-- fix [#284](https://github.com/kelektiv/node-uuid/issues/284) by setting function name in try-catch ([f2a60f2](https://github.com/kelektiv/node-uuid/commit/f2a60f2))
+- typo ([305d877](https://github.com/uuidjs/uuid/commit/305d877))
+
+## [3.3.1](https://github.com/uuidjs/uuid/compare/v3.3.0...v3.3.1) (2018-06-28)
 
-<a name="3.3.0"></a>
+### Bug Fixes
+
+- fix [#284](https://github.com/uuidjs/uuid/issues/284) by setting function name in try-catch ([f2a60f2](https://github.com/uuidjs/uuid/commit/f2a60f2))
 
-# [3.3.0](https://github.com/kelektiv/node-uuid/compare/v3.2.1...v3.3.0) (2018-06-22)
+# [3.3.0](https://github.com/uuidjs/uuid/compare/v3.2.1...v3.3.0) (2018-06-22)
 
 ### Bug Fixes
 
-- assignment to readonly property to allow running in strict mode ([#270](https://github.com/kelektiv/node-uuid/issues/270)) ([d062fdc](https://github.com/kelektiv/node-uuid/commit/d062fdc))
-- fix [#229](https://github.com/kelektiv/node-uuid/issues/229) ([c9684d4](https://github.com/kelektiv/node-uuid/commit/c9684d4))
-- Get correct version of IE11 crypto ([#274](https://github.com/kelektiv/node-uuid/issues/274)) ([153d331](https://github.com/kelektiv/node-uuid/commit/153d331))
-- mem issue when generating uuid ([#267](https://github.com/kelektiv/node-uuid/issues/267)) ([c47702c](https://github.com/kelektiv/node-uuid/commit/c47702c))
+- assignment to readonly property to allow running in strict mode ([#270](https://github.com/uuidjs/uuid/issues/270)) ([d062fdc](https://github.com/uuidjs/uuid/commit/d062fdc))
+- fix [#229](https://github.com/uuidjs/uuid/issues/229) ([c9684d4](https://github.com/uuidjs/uuid/commit/c9684d4))
+- Get correct version of IE11 crypto ([#274](https://github.com/uuidjs/uuid/issues/274)) ([153d331](https://github.com/uuidjs/uuid/commit/153d331))
+- mem issue when generating uuid ([#267](https://github.com/uuidjs/uuid/issues/267)) ([c47702c](https://github.com/uuidjs/uuid/commit/c47702c))
 
 ### Features
 
-- enforce Conventional Commit style commit messages ([#282](https://github.com/kelektiv/node-uuid/issues/282)) ([cc9a182](https://github.com/kelektiv/node-uuid/commit/cc9a182))
+- enforce Conventional Commit style commit messages ([#282](https://github.com/uuidjs/uuid/issues/282)) ([cc9a182](https://github.com/uuidjs/uuid/commit/cc9a182))
 
-<a name="3.2.1"></a>
-
-## [3.2.1](https://github.com/kelektiv/node-uuid/compare/v3.2.0...v3.2.1) (2018-01-16)
+## [3.2.1](https://github.com/uuidjs/uuid/compare/v3.2.0...v3.2.1) (2018-01-16)
 
 ### Bug Fixes
 
-- use msCrypto if available. Fixes [#241](https://github.com/kelektiv/node-uuid/issues/241) ([#247](https://github.com/kelektiv/node-uuid/issues/247)) ([1fef18b](https://github.com/kelektiv/node-uuid/commit/1fef18b))
-
-<a name="3.2.0"></a>
+- use msCrypto if available. Fixes [#241](https://github.com/uuidjs/uuid/issues/241) ([#247](https://github.com/uuidjs/uuid/issues/247)) ([1fef18b](https://github.com/uuidjs/uuid/commit/1fef18b))
 
-# [3.2.0](https://github.com/kelektiv/node-uuid/compare/v3.1.0...v3.2.0) (2018-01-16)
+# [3.2.0](https://github.com/uuidjs/uuid/compare/v3.1.0...v3.2.0) (2018-01-16)
 
 ### Bug Fixes
 
-- remove mistakenly added typescript dependency, rollback version (standard-version will auto-increment) ([09fa824](https://github.com/kelektiv/node-uuid/commit/09fa824))
-- use msCrypto if available. Fixes [#241](https://github.com/kelektiv/node-uuid/issues/241) ([#247](https://github.com/kelektiv/node-uuid/issues/247)) ([1fef18b](https://github.com/kelektiv/node-uuid/commit/1fef18b))
+- remove mistakenly added typescript dependency, rollback version (standard-version will auto-increment) ([09fa824](https://github.com/uuidjs/uuid/commit/09fa824))
+- use msCrypto if available. Fixes [#241](https://github.com/uuidjs/uuid/issues/241) ([#247](https://github.com/uuidjs/uuid/issues/247)) ([1fef18b](https://github.com/uuidjs/uuid/commit/1fef18b))
 
 ### Features
 
-- Add v3 Support ([#217](https://github.com/kelektiv/node-uuid/issues/217)) ([d94f726](https://github.com/kelektiv/node-uuid/commit/d94f726))
+- Add v3 Support ([#217](https://github.com/uuidjs/uuid/issues/217)) ([d94f726](https://github.com/uuidjs/uuid/commit/d94f726))
 
-# [3.1.0](https://github.com/kelektiv/node-uuid/compare/v3.1.0...v3.0.1) (2017-06-17)
+# [3.1.0](https://github.com/uuidjs/uuid/compare/v3.1.0...v3.0.1) (2017-06-17)
 
 ### Bug Fixes
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,20 @@
+# Contributing
+
+Please feel free to file GitHub Issues or propose Pull Requests. We're always happy to discuss
+improvements to this library!
+
+## Testing
+
+```shell
+npm test
+```
+
+## Releasing
+
+Releases are supposed to be done from master, version bumping is automated through
+[`standard-version`](https://github.com/conventional-changelog/standard-version):
+
+```shell
+npm run release -- --dry-run  # verify output manually
+npm run release               # follow the instructions from the output of this command
+```
diff --git a/README.md b/README.md
@@ -106,10 +106,10 @@ uuid(); // ⇨ '1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed'
 There is experimental native ESM support for [the browser](./examples/browser-esmodules/) but it
 should not be considered ready for production use and may change or disappear in future releases.
 
-To run the examples you must first build a dist package of this library in the module root:
+To run the examples you must first create a dist build of this library in the module root:
 
 ```
-npm run package
+npm run build
 ```
 
 ## API
@@ -313,11 +313,5 @@ $ uuid v1
 
 Type `uuid --help` for usage details
 
-## Testing
-
-```shell
-npm test
-```
-
 ----
 Markdown generated from [README_js.md](README_js.md) by [![RunMD Logo](http://i.imgur.com/h0FVyzU.png)](https://github.com/broofa/runmd)
diff --git a/README_js.md b/README_js.md
@@ -115,10 +115,10 @@ uuid(); // ⇨ '1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed'
 There is experimental native ESM support for [the browser](./examples/browser-esmodules/) but it
 should not be considered ready for production use and may change or disappear in future releases.
 
-To run the examples you must first build a dist package of this library in the module root:
+To run the examples you must first create a dist build of this library in the module root:
 
 ```
-npm run package
+npm run build
 ```
 
 ## API
@@ -291,9 +291,3 @@ $ uuid v1
 ```
 
 Type `uuid --help` for usage details
-
-## Testing
-
-```shell
-npm test
-```
diff --git a/examples/browser-esmodules/package-lock.json b/examples/browser-esmodules/package-lock.json
diff --git a/examples/browser-esmodules/package.json b/examples/browser-esmodules/package.json
@@ -7,6 +7,6 @@
     "start": "npm run build && npx http-server . -o"
   },
   "dependencies": {
-    "uuid": "file:../../dist"
+    "uuid": "file:../../.local"
   }
 }
diff --git a/examples/browser-rollup/package-lock.json b/examples/browser-rollup/package-lock.json
diff --git a/examples/browser-rollup/package.json b/examples/browser-rollup/package.json
@@ -7,7 +7,7 @@
     "start": "npm run build && npx http-server . -o"
   },
   "dependencies": {
-    "uuid": "file:../../dist"
+    "uuid": "file:../../.local"
   },
   "devDependencies": {
     "rollup": "^1.24.0",