jonaslagoni/Automated Version Bump for AsyncAPI
Automated version bump for AsyncAPI documents to follow Semantic Versioning.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| tag-prefix | Prefix that is used for the git tag | no | "" |
| minor-wording | Words list that trigger a minor version bump. Use "," to separate multiple words. | no | feat |
| major-wording | Words list that trigger a major version bump. Use "," to separate multiple words. | no | feat!,fix!,refactor! |
| patch-wording | Words list that trigger a patch version bump. Use "," to separate multiple words. | no | fix |
| release-candidate-wording | Words list that trigger a release candidate version bump. Use "," to separate multiple words. | no | next |
| skip-tag | Avoid to add a TAG to the version update commit | no | true |
| skip-commit | Avoid to add a commit after the version is bumped | no | false |
| skip-push | If true, skip pushing any commits or tags created after the version bump | no | false |
| path-to-asyncapi | Path to the AsyncAPI document to bump | no | ./asyncapi.json |
| target-branch | A separate branch to perform the version bump on | no | "" |
| pre-release-id | Set a custom id for pre-release build | no | next |
| dry-run | This makes sure that no changes are made to the AsyncAPI document and no changes are committed. Use this to determine if any bumps is necessary. | no | false |
| commit-message | Set a custom commit message for version bump commit. Use {{version}} as a placeholder for the new version. | no | ci: version bump to {{version}} |
| release-commit-message-regex | Set the regex to match release commit messages so the action knows which commit messages to use and which to ignore. Usually it is similar or the same as `commit-message`. Use {{version}} as a placeholder for the new version. Defaults to commit-message input. | no | — |
Outputs
| name | description |
|---|---|
| wasBumped | Boolean to check if document was bumped |
| newVersion | The new version of the AsyncAPI document |
| oldVersion | The old version of the AsyncAPI document |