FortyTwoJS
An npm package to demonstrate how to test, build and publish to the NPM Registry using CircleCI.
Prerequisites
Development
Install dependencies (substitute 'npm' if you don't have yarn):
$ npm install
Lint and run tests:
$ npm run lint
$ npm test
Workflow
TL;DR: Use GitHub Flow.
In more detail:
- Create a feature branch.
- Create and push commits on that branch.
- The feature branch will get built on CircleCI with each push.
- Update the CHANGELOG with description of changes.
- Create a Pull Request on BitBucket.
- When the feature PR is merged, master will get built on CircleCI.
Releasing
-
Update the CHANGELOG to list the new version.
-
Add files and commit
$ git add CHANGELOG.md ... $ git commit -m "Release v.X.Y.Z"
-
Bump the version to the desired level:
$ npm version (major|minor|patch)
-
Push
$ git push origin master --tags
The new version will get built in CircleCI and pushed to the NPM Registry.
Installing
To install and use it in another project:
$ npm install fortytwojs
License
This code is licensed and distributed under the terms of the MIT License (see LICENSE).