-
-
Notifications
You must be signed in to change notification settings - Fork 915
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
build: set up and document build and release scripts
Since we have a build step now we must point the package.json file reference to the dist folder and must explicitly list all files that we want to be included in the npm tarball. The initial idea was to prepare the contents of the final npm tarball all in the dist directory (including a copy of the package.json) but that turns out not to work particularly well with standard-version which is used to manage the version numbers and changelog. Unfortunately this change also required a small workaround to allow local installation of the uuid module in the examples (see .local/). Also instructions for relasing a new version have not yet been documented which is finally done here. Since we now explicitly list all files to be included in the tarball through the files property of package.json we no longer need the .npmignore file.
- Loading branch information
Showing
16 changed files
with
242 additions
and
178 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../dist |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../package.json |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.