diff --git a/README.md b/README.md index 286f4b6..6ef5c70 100644 --- a/README.md +++ b/README.md @@ -89,6 +89,15 @@ jobs: ## Inputs + + +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +|----------------------|--------|----------|-------------------------|-------------------------------------------------------------------| +| initial\_release\_type | string | true | `"patch"` | Initial release type returned when there
are no existing tags. | +| token | string | true | `"${{ github.token }}"` | GITHUB\_TOKEN or a Repo scoped PAT | + + + | Input | type | required | default | description | |:-------------:|:-----------:|:-------------:|:----------------------------:|:-------------:| | token | `string` | `true` | `${{ github.token }}` | [GITHUB\_TOKEN](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)
or a repo scoped
[Personal Access Token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) | @@ -96,6 +105,16 @@ jobs: ## Outputs + + +| OUTPUT | TYPE | DESCRIPTION | +|--------------|--------|---------------------------------------------------------------------------------------------------------| +| new\_version | string | The current project version | +| old\_version | string | The previous project version | +| release\_type | string | The difference between two versions by
the release type (major, minor, patch,
prerelease, build) | + + + | Output | type | description | |:-------------:|:-----------:|:-------------:| | release\_type | `string` | The difference between two versions by release type
(major, minor, patch, prerelease, build) |