Skip to content

Commit 16bcc94

Browse files
authored
docs(README): update notes
1 parent a1ad0ba commit 16bcc94

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,13 @@ jobs:
4545

4646
### Inputs
4747

48-
| Inputs | Description | Required | Default |
49-
| -------------- | ------------------------------------------------ | -------- | --------------------------------------------- |
50-
| REPO_NAME | Repository name | yes | - |
51-
| ACCESS_TOKEN | Github Access Token | yes | You can just pass `${{secrets.GITHUB_TOKEN}}` |
52-
| PATH | Path to the your file | no | `/CHANGELOG.md` |
53-
| COMMIT_MESSAGE | commit message | no | `docs(CHANGELOG): update release notes` |
54-
| TYPE | The type of commits you want to add to CHANGELOG | no | 'feat:Feature,fix:Fix' |
48+
| Inputs | Description | Required | Default |
49+
| -------------- | ------------------------------------------------ | -------- | --------------------------------------------------------- |
50+
| REPO_NAME | Repository name | yes | No. **Please do remember to change it to your repo name** |
51+
| ACCESS_TOKEN | Github Access Token | yes | You can just pass `${{secrets.GITHUB_TOKEN}}` |
52+
| PATH | Path to the your file | no | `/CHANGELOG.md` |
53+
| COMMIT_MESSAGE | commit message | no | `docs(CHANGELOG): update release notes` |
54+
| TYPE | The type of commits you want to add to CHANGELOG | no | 'feat:Feature,fix:Fix' |
5555

5656
> You can define the keyword detected from commit message and the corresonding word presented in the changelog in input `TYPE`. For example, define `feat:Feature` will detect commit message like `feat(main): add new option` and present this in changelog as part `Feature`
5757
>

0 commit comments

Comments
 (0)