Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Synchronize README.md with action.yml #6

Merged
merged 1 commit into from
May 27, 2024
Merged

docs: Synchronize README.md with action.yml #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,20 @@ jobs:

## Inputs

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| ----------------------------------------------------------------------------------------------------- | ------ | -------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| <a name="input_accept_breaking_changes"></a>[accept_breaking_changes](#input_accept_breaking_changes) | string | false | `"true"` | Is the breaking change indicator <br>(`!`) allowed? |
| <a name="input_accept_emoji"></a>[accept_emoji](#input_accept_emoji) | string | false | `"true"` | Are emoji allowed? |
| <a name="input_accepted_scopes"></a>[accepted_scopes](#input_accepted_scopes) | string | false | | Only accept these scopes. Provide <br>as multi-line string, each type <br>on it's own line. By <br>default, all scopes are accepted. |
| <a name="input_accepted_types"></a>[accepted_types](#input_accepted_types) | string | false | `"feat"`<br>`"fix"`<br> | Only accept these type prefixes. <br>Provide as multi-line string, each <br>type on it's own line. |
| <a name="input_repo_token"></a>[repo_token](#input_repo_token) | string | true | | Needs `secrets.GITHUB_TOKEN` to talk to <br>the API. |
| <a name="input_require_conventional"></a>[require_conventional](#input_require_conventional) | string | false | `"true"` | Require all commits to follow <br>the Conventional Commits specification |
| <a name="input_require_scope"></a>[require_scope](#input_require_scope) | string | false | `"false"` | Require all commits to specify <br>a scope. |

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

## Release Process

```shell
Expand Down