Skip to content

Document go-bump companion action #34

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
bcomnes merged 3 commits into from
Sep 4, 2026
Merged

Document go-bump companion action #34

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a3304e6
Document go-bump companion action
bcomnes Sep 4, 2026
91b6196
Update README logo placement
bcomnes Sep 4, 2026
cca8d65
Link to maintained go-bump examples
bcomnes Sep 4, 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
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# goversion
![goversion: Bump. Tag. Publish.](logos/og.png)

![goversion logo](logo.png)
# goversion

[![Actions Status][action-img]][action-url]
[![SocketDev][socket-image]][socket-url]
Expand Down Expand Up @@ -118,6 +118,12 @@ go get -tool github.com/bcomnes/goversion/v2

## Usage

### GitHub Actions companion

[`go-bump`](https://github.com/bcomnes/go-bump) is the companion GitHub Action for running a `goversion` release in CI. `goversion` remains the local-first workflow: register it as a project-pinned Go tool so contributors can create, validate, publish, and recover releases locally. `go-bump` uses that same pinned tool and adds GitHub Actions input handling, credentials, Git identity, lifecycle hooks, and outputs.

See the [`go-bump` documentation](https://github.com/bcomnes/go-bump#readme) for current workflow examples, requirements, inputs, outputs, nested-module configuration, publication controls, and recovery behavior.

### Command-Line Interface

The `goversion` CLI defaults to the module in the current directory and `./version.go`. Use `-workdir` to select a root or nested module without changing the caller's working directory. Relative `-version-file`, `-file`, `-bump-file`, and `-post-bump` paths are resolved within that workdir.
Expand Down Expand Up @@ -330,3 +336,5 @@ For detailed API documentation, visit [PkgGoDev][pkg-go-dev-url].
## License

This project is licensed under the MIT License.

![Go gopher operating the version machine](logo.png)