Version check

You can use this GitHub action to check whether your npm package version has been updated: this can be extremely helpful if you want to automate your release process.
The main difference between this action and many others out there is that this doesn't do a specific task (it doesn't publish to registries, create tags or releases, send notifications, ...) but instead gives you an output that you can use in other steps of your workflow as you prefer: this way you don't have to deal with stuff you don't care about ;)

This action is heavily inspired by npm-publish-action by pascal: if you only care about publishing your package to npm automatically, this is the simplest solution 👍

Usage

You have to set up a step like this in your workflow (this assumes you've already checked out your repo and set up Node):

- name: Check if version has been updated # You can edit this
    id: check # This will be the reference for getting the outputs
    uses: EndBug/version-check@v1.1.0 # You can choose the version/branch you prefer
    with: # You can find more info about inputs below
      diff-search: true
      file-name: package.json
      token: ${{ secrets.GITHUB_TOKEN }}

Inputs

diff-search (optional) : whether to search in every commit's diff. This is useful if you often do change the version manually without including it in the title: you can find more info on how the action detects the version change here. If you only use npm version to bump versions then you can omit this.
file-name (optional) : you can use this to indicate a custom path to your package.json; if you keep your package file in the root directory (as every normal person would do) you can omit this.
token (optional) : you can put your bearer GitHub token here. This is needed only when running the action on private repostiories, if you're running it on a public repo you can omit this. If you need to set this, you can use the built-in GITHUB_TOKEN secret that GitHub generates for your repo's actions: you cna find more info about it here.

Outputs

This action sets two outputs:

changed : either "true" or "false", indicates whether the version has changed.
type : if the version has changed, it tries to find the type of bump (e.g. "patch", "minor", ...)
version : if the version has changed, it shows the version number (e.g. "1.0.2")

To access these outputs, you need to access the context of the step you previously set up: you can find more info about steps contexts here.
If you set your step id to check you'll find the outputs at steps.check.outputs.changed, steps.check.outputs.type and steps.check.outputs.version: you can use these outputs as conditions for other steps.
Here's an example:

- name: Check if version has been updated
  id: check
  uses: EndBug/version-check@v1.1.0

- name: Log when changed
  if: steps.check.outputs.changed == 'true'
  run: 'echo "Version change found! New version: ${{ steps.check.outputs.version }} (${{ steps.steps.check.outputs.type }})"'

- name: Log when unchanged
  if: steps.check.outputs.changed != 'true'
  run: 'echo "No version change :/"'

Publishing automatically to both NPM & GitHub Package Registry

If you want to see how to publish automatically your package to both NPM & GPR, please see this example workflow ;) You can also find a more in-depth guide in this here.

Contributing

If you want to contribute to the action, even by just raising a problem or proposing an idea, you can click here to find out how to do it ;)

License

This action is distributed under the MIT license, check the license for more info.

hsalazr / version-check