Skip to content

Automatically release all merges to master on npm.

License

Notifications You must be signed in to change notification settings

Adeelessa/merge-release

 
 

Repository files navigation

merge-release

GitHub Action for automated npm publishing.

This Action publishes a package to npm. It is meant to be used on every successful merge to master but you'll need to configured that workflow yourself. You can look to the .github/workflows/push.yml file in this project as an example.

Workflow

  • Check for the latest version number published to npm.
  • Lookup all commits between the git commit that triggered the action and the latest publish.
    • If the package hasn't been published or the prior publish does not include a git hash, we'll only pull the commit data that triggered the action.
  • Based on the commit messages, increment the version from the lastest release.
    • If the string "BREAKING CHANGE" is found anywhere in any of the commit messages or descriptions the major version will be incremented.
    • If a commit message begins with the string "feat" then the minor version will be increased. This works for most common commit metadata for feature additions: "feat: new API" and "feature: new API".
    • All other changes will increment the patch version.
  • Publish to npm using the configured token.
  • Push the bumped npm version in package.json back into the repo.
  • Push a tag for the new version to GitHub.

About

Automatically release all merges to master on npm.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 56.2%
  • Shell 28.8%
  • Dockerfile 15.0%