Skip to content

Fix documentation #7

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

Merged
ekini merged 2 commits into from
Apr 8, 2026
Merged

Fix documentation #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b91df79
Fix documentation
ekini Apr 8, 2026
69431c0
Update README.md
ekini Apr 8, 2026
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
21 changes: 11 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,22 +216,23 @@ _Example3 (with breaking message):_

You can configure the action with various inputs, a list of which has been provided below:

| Name | Description | Default Value |
|------------------|-------------------------------------------------------------------------------------------------|---------------|
| tool-version | The version of the tool to run | latest |
| release-branch | The name of the master/main branch | master |
| dev-branch | The name of the development branch | dev |
| skip-prerelease | Skip prerelease part of the version. When true, release-branch and dev-branch are effectively ignored | false |
| minor-identifier | The string used to identify a minor release (wrap with '/' to match using a regular expression) | feature: |
| major-identifier | The string used to identify a major release (wrap with '/' to match using a regular expression) | breaking: |
| prefix | The prefix used for the version name | |
| log-paths | The paths used to calculate changes (comma-separated) | |
| Name | Description | Default Value |
| ---------------- | ----------------------------------------------------------------------------------------------------- | ------------- |
| tool-version | The version of the tool to run | latest |
| release-branch | The name of the master/main branch | master |
| dev-branch | The name of the development branch | dev |
| skip-prerelease | Skip prerelease part of the version. When true, release-branch and dev-branch are effectively ignored | false |
| minor-identifier | The string used to identify a minor release (wrap with '/' to match using a regular expression) | feature: |
| major-identifier | The string used to identify a major release (wrap with '/' to match using a regular expression) | breaking: |
| prefix | The prefix used for the version name | |
| log-paths | The paths used to calculate changes (whitespace-separated) | |

## Requirements

To use this tool you will need to install a few dependencies:

Ubuntu:

```
sudo apt-get install \
libevent-dev \
Expand Down
Loading