Skip to content

Commit db79617

Browse files
committed
docs: refer to semver-diff for diff types
Ref #158 (comment)
1 parent 8240855 commit db79617

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Version check
22

33
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
4+
45
[![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat-square)](#contributors-)
6+
57
<!-- ALL-CONTRIBUTORS-BADGE:END -->
68

79
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.
@@ -23,7 +25,7 @@ You have to set up a step like this in your workflow (this assumes you've alread
2325
with:
2426
# All these parameters are optional,
2527
# check their descriptions to see if you need them.
26-
28+
2729
# Whether to search in every commit's diff.
2830
# This is useful if you often do change the version without saying it in the
2931
# commit message. If you always include the semver of the new version in your
@@ -40,7 +42,7 @@ You have to set up a step like this in your workflow (this assumes you've alread
4042
# You can put your bearer GitHub token here. This is needed only when running
4143
# the action on private repostiories, if you're running it on a public repo you
4244
# can omit this.
43-
# If you need to set this, you can use the built-in `GITHUB_TOKEN` secret that
45+
# If you need to set this, you can use the built-in `GITHUB_TOKEN` secret that
4446
# GitHub generates for your repo's actions: you can find more info about it here:
4547
# https://help.github.com/en/github/automating-your-workflow-with-github-actions/virtual-environments-for-github-actions#github_token-secret
4648
# Default: ''
@@ -86,7 +88,7 @@ Please note that even if the action is built to be easier as possible to use, it
8688
### Outputs
8789

8890
- `changed`: either "true" or "false", indicates whether the version has changed.
89-
- `type`: if the version has changed, it tries to find the type of bump (e.g. "patch", "minor", ...)
91+
- `type`: if the version has changed, it tries to find the type of bump (e.g. "patch", "minor", ...). To see the full list of available types, please refer to the [`semver-diff` docs](https://github.com/sindresorhus/semver-diff/blob/1f2ac09e19213122094b9c49c7ac9bf4089da93b/readme.md)
9092
- `version`: if the version has changed, it shows the version number (e.g. "1.0.2")
9193
- `commit`: if the version has changed, it shows the sha of the commit where the change has been found.
9294

0 commit comments

Comments
 (0)