Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prantlf/finish-release-action
GitHub action for committing and pushing changes related to versioning an for creating a new release with artefacts.
https://github.com/prantlf/finish-release-action
actions github github-actions publish release v vlang
Last synced: about 2 months ago
JSON representation
GitHub action for committing and pushing changes related to versioning an for creating a new release with artefacts.
- Host: GitHub
- URL: https://github.com/prantlf/finish-release-action
- Owner: prantlf
- License: mit
- Created: 2023-10-23T10:16:56.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-11T13:52:09.000Z (11 months ago)
- Last Synced: 2024-02-12T10:27:50.528Z (11 months ago)
- Topics: actions, github, github-actions, publish, release, v, vlang
- Homepage: https://github.com/marketplace/actions/commit-version-and-create-release
- Size: 29.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Commit Version and Create Release
GitHub action for committing and pushing changes related to versioning an for creating a new release with artefacts.
Uses tools [newchanges] and [vp]. Usually run after [prantlf/bump-version-action]. Only platforms Linux, macOS, Windows on the architecture X64 are supported.
## Usage
Commit and push the changelog using the latest version written to it and create a new release:
```yml
- uses: prantlf/finish-release-action@v1
```
Work only in specific release branches, run only if new version is detected in the commit messages by [prantlf/bump-version-action]:
```yml
jobs:
build:
steps:
- uses: actions/checkout@v4
- uses: prantlf/setup-v-action@v2
- name: Bump version
id: bump
uses: prantlf/bump-version-action@v1
- run: ...
- uses prantlf/finish-release-action@v1
if: ${{ steps.bump.outputs.bumped }}
with:
branches: master v1.x
```
## Inputs
The following parameters can be specified using the `with` object:
### branches
Type: `String`
Default: `'main master'`
Branches which this action should run for, which are used to publishing releases. Use whitespace for separating the branch names. If you want to use multiple lines in YAML, introduce them with ">-". If you want to allow all branches, set the value to "*".
### enable
Type: `Boolean`
Default: `true`
Can be set to `false` to prevent this action from running. It's helpful in the pipeline, which will not continue releasing, but only building and testing, and that will be decided in the middle of a job execution.
### no-node
Type: `Boolean`
Default: `false`
Set to `true` to ignore `package.json` and not handle the project as a Node.js package.
### no-vlang
Type: `Boolean`
Default: `false`
Set to `true` not to ignore `v.mod` and not handle the project as a V package.
### no-rust
Type: `Boolean`
Default: `false`
Set to `true` not to ignore `Cargo.toml` and not handle the project as a Rust package.
### no-golang
Type: `Boolean`
Default: `false`
Set to `true` not to ignore `go.mod` and not handle the project as a Go package.
### no-bump
Type: `Boolean`
Default: `false`
Set to `true` not to bump the version number in source files. Only the changelog will be modified.
### no-commit
Type: `Boolean`
Default: `false`
Set to `true` not to commit the changes. If you set `no-bump`, you'll likely want to set `no-commit` and `no-push` too.
### no-commit-skip-ci
Type: `Boolean`
Default: `false`
Set to `true` not to add `[skip ci]` to the commit message of the changes. Doing it will have another pipeline triggered, if commits are watched.
### no-tag
Type: `Boolean`
Default: `false`
Set to `true` not to tag the commits. If you set `no-commit`, you don't have to set `no-tag`.
### no-tag-skip-ci
Type: `Boolean`
Default: `false`
Set to `true` not to add `[skip ci]` to the commit message of the tag. Doing it will have another pipeline triggered, if tags are watched.
### no-push
Type: `Boolean`
Default: `false`
Set to `true` not to push the committed changes. If you set `no-bump`, you'll likely want to set `no-commit` and `no-push` too.
### no-archives
Type: `Boolean`
Default: `false`
Set to `true` not to upload platform archives automatically as release assets.
### bump-major-0
Type: `Boolean`
Default: `false`
Set to `true` to bump the major version also if it is 0.
### dry-run
Type: `Boolean`
Default: `false`
Can be set to `true` to only print what would be done without actually doing it.
### debug
Type: `Boolean`
Default: `false`
Can be set to `true` to enable debug logging of the supporting tools. Debug logging will be enabled also if it's enabled on the runner.
## License
Copyright (C) 2023-2024 Ferdinand Prantl
Licensed under the [MIT License].
[MIT License]: http://en.wikipedia.org/wiki/MIT_License
[prantlf/bump-version-action]: https://github.com/prantlf/prantlf/bump-version-action
[newchanges]: https://github.com/prantlf/v-newchanges
[vp]: https://github.com/prantlf/vp