Skip to content

Commit

Permalink
Merge pull request #208 from tj-actions/chore/update-readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jackton1 committed Dec 28, 2022
2 parents 898155b + c1dd699 commit fe3ad78
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Expand Up @@ -19,10 +19,14 @@ Generate CHANGELOG/HISTORY markdown files for your project

## Inputs

| 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) <br /> or a repo scoped <br /> [Personal Access Token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) |
| output | `string` | `false` | `CHANGELOG.md` | The Changelog output file. |
<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|--------|--------|----------|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| output | string | false | `"CHANGELOG.md"` | The changelog output file |
| 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<br>Token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) |

<!-- AUTO-DOC-INPUT:END -->

* Free software: [MIT license](LICENSE)

Expand Down

0 comments on commit fe3ad78

Please sign in to comment.