dabutvin / example-npm

An example GitHub Action using npm

npm GitHub Action Example

An example workflow, using the GitHub Action for npm to build, test, and publish an npm module, @scrabblescore/scrabblescore.

Workflow

The example workflow will trigger on every push to this repo.

For pushes to a feature branch, the workflow will:

1. Run npm install, to install the module's prerequisites
2. Run npm test, to run the module's unit tests

For pushes to the default branch (master), in addition to the above Actions, the workflow will:

1. Run npm publish, to release the module to the world

License

This repository is licensed under CC0-1.0, which waives all copyright restrictions.