Skip to content

Commit d5a763e

Browse files
docs: add hooks config
1 parent bc71199 commit d5a763e

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,19 @@ steps:
1818
1919
## Arguments
2020
21-
| Input | Description | Usage |
22-
|--------------------------------------|----------------------------------------------------------------------------------------|----------|
23-
| `github-token` | Used to create releases | Required |
24-
| `changelog-file` | Create a changelog file | Optional |
25-
| `ghr` | Create a .ghr file with the parameters for [tcnksm/ghr](https://github.com/tcnksm/ghr) | Optional |
26-
| `update-file` | Update the version of a certain file | Optional |
27-
| `dry` | Do not create a release | Optional |
28-
| `prerelease` | Flags the release as a prerelease | Optional |
21+
| Input | Description | Usage |
22+
|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
23+
| `github-token` | Used to create releases | Required |
24+
| `changelog-file` | Create a changelog file (e.g CHANGELOG.md) | Optional |
25+
| `ghr` | Create a .ghr file with the parameters for [tcnksm/ghr](https://github.com/tcnksm/ghr) | Optional |
26+
| `update-file` | Update the version of a certain file | Optional |
27+
| `dry` | Do not create a release | Optional |
28+
| `prerelease` | Flags the release as a prerelease | Optional |
2929
| `allow-initial-development-versions` | semantic-release will start your initial development release at 0.1.0 and will handle breaking changes as minor version updates. This option will be ignored if a release with major version greater than or equal 1 exists. | Optional |
30-
| `force-bump-patch-version` | Increments the patch version if no changes are found | Optional |
31-
| `changelog-generator-opt` | Options that are passed to the changelog-generator plugin. Seperated by "," | Optional |
32-
| `prepend` | Flag changes to be prepended into the changelog | Optional |
30+
| `force-bump-patch-version` | Increments the patch version if no changes are found | Optional |
31+
| `changelog-generator-opt` | Options that are passed to the changelog-generator plugin. Seperated by "," | Optional |
32+
| `prepend` | Flag changes to be prepended into the changelog file | Optional |
33+
| `hooks` | Enable different hooks plugins. Seperated by "," | Optional |
3334

3435
## Example `ci.yml` for a npm package
3536

0 commit comments

Comments
 (0)