Skip to content
This repository has been archived by the owner on Jan 13, 2024. It is now read-only.

docs(README): no input is required #265

Merged
merged 1 commit into from
Apr 12, 2023
Merged

docs(README): no input is required #265

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
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,28 @@ See [Conventional Commits](https://www.conventionalcommits.org/) for sample titl

### `success-state`

**Required** Description of the status check if validation succeeds. Default `"Title follows the specification."`.
**Optional** Description of the status check if validation succeeds.
> Default: `"Title follows the specification."`.

### `failure-state`

**Required** Description of the status check if validation fails. Default `"Title does not follow the specification."`.
**Optional** Description of the status check if validation fails.
> Default: `"Title does not follow the specification."`.

### `context-name`

**Required** Persistent status check context key. Default `"conventional-pr-title"`.
**Optional** Persistent status check context key.
> Default: `"conventional-pr-title"`.

### `preset`

**Required** Conventional changelog preset. Default `"conventional-changelog-conventionalcommits@5.0.0"`.
**Optional** Conventional changelog preset.
> Default: `"conventional-changelog-conventionalcommits@5.0.0"`.

### `target-url`

**Optional** URL to be used when linking the "Details" in the actions overview. Default `"https://www.conventionalcommits.org/en/v1.0.0/#summary"`.
**Optional** URL to be used when linking the "Details" in the actions overview.
> Default: `"https://www.conventionalcommits.org/en/v1.0.0/#summary"`.

## Outputs

Expand Down