feat: default to release-version file
Some checks failed
Some checks failed
This commit is contained in:
@@ -44,10 +44,12 @@ go run ./cmd/vociferate --recommend --root .
|
||||
|
||||
Defaults:
|
||||
|
||||
- `version-file`: `internal/vociferate/version/version.go`
|
||||
- `version-pattern`: `const String = "([^"]+)"`
|
||||
- `version-file`: `release-version`
|
||||
- `version-pattern`: `^\s*([^\r\n]+)\s*$`
|
||||
- `changelog`: `changelog.md`
|
||||
|
||||
By default, `vociferate` reads and writes the release version as the sole content of a root-level `release-version` file. Repositories that keep the version inside source code should pass explicit `version-file` and `version-pattern` values.
|
||||
|
||||
## Testing
|
||||
|
||||
```bash
|
||||
@@ -81,6 +83,7 @@ Use the composite action directly:
|
||||
|
||||
Set `version` only when you want to override the recommended version.
|
||||
Pin the composite action to a released tag. It downloads a prebuilt Linux binary from vociferate releases and caches it on the runner, so it does not require installing Go.
|
||||
If your repository uses the default plain-text `release-version` file, you can omit `version-file` and `version-pattern` entirely.
|
||||
|
||||
Call the reusable release workflow:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user