refactor: rename releaseprep to vociferate
This commit is contained in:
17
README.md
17
README.md
@@ -13,7 +13,7 @@ just go-build
|
||||
Or directly with Go:
|
||||
|
||||
```bash
|
||||
go build -o dist/releaseprep ./cmd/releaseprep
|
||||
go build -o dist/vociferate ./cmd/vociferate
|
||||
```
|
||||
|
||||
## Usage
|
||||
@@ -21,13 +21,15 @@ go build -o dist/releaseprep ./cmd/releaseprep
|
||||
Prepare release files:
|
||||
|
||||
```bash
|
||||
go run ./cmd/releaseprep --version v1.2.3 --date 2026-03-20 --root .
|
||||
go run ./cmd/vociferate --version v1.2.3 --date 2026-03-20 --root .
|
||||
```
|
||||
|
||||
In the provided workflow and composite action, `version` is optional. When it is omitted, vociferate computes and uses the recommended next version automatically.
|
||||
|
||||
Recommend next release tag from changelog content:
|
||||
|
||||
```bash
|
||||
go run ./cmd/releaseprep --recommend --root .
|
||||
go run ./cmd/vociferate --recommend --root .
|
||||
```
|
||||
|
||||
### Flags
|
||||
@@ -42,7 +44,7 @@ go run ./cmd/releaseprep --recommend --root .
|
||||
|
||||
Defaults:
|
||||
|
||||
- `version-file`: `internal/releaseprep/version/version.go`
|
||||
- `version-file`: `internal/vociferate/version/version.go`
|
||||
- `version-pattern`: `const String = "([^"]+)"`
|
||||
- `changelog`: `changelog.md`
|
||||
|
||||
@@ -76,12 +78,13 @@ Use the composite action directly:
|
||||
- name: Prepare release files
|
||||
uses: git.hrafn.xyz/aether/vociferate@main
|
||||
with:
|
||||
version: v1.2.3
|
||||
version-file: internal/myapp/version/version.go
|
||||
version-pattern: 'const Version = "([^"]+)"'
|
||||
changelog: changelog.md
|
||||
```
|
||||
|
||||
Set `version` only when you want to override the recommended version.
|
||||
|
||||
Call the reusable release workflow:
|
||||
|
||||
```yaml
|
||||
@@ -91,8 +94,8 @@ on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
version:
|
||||
description: Semantic version to release.
|
||||
required: true
|
||||
description: Optional semantic version override.
|
||||
required: false
|
||||
|
||||
jobs:
|
||||
release:
|
||||
|
||||
Reference in New Issue
Block a user