docs: refine changelog for initial release
All checks were successful
Push Validation / validate (push) Successful in 53s
All checks were successful
Push Validation / validate (push) Successful in 53s
This commit is contained in:
12
README.md
12
README.md
@@ -1,6 +1,6 @@
|
||||
# vociferate
|
||||
|
||||
`vociferate` is a release orchestration tool written in Go for repositories that
|
||||
`vociferate` is an `aether` release orchestration tool written in Go for repositories that
|
||||
want changelog-driven versioning, automated release preparation, and repeatable
|
||||
tag publication.
|
||||
|
||||
@@ -9,7 +9,7 @@ recommend the next semantic version, promote `Unreleased` changelog entries,
|
||||
commit and tag a release, and publish release notes/assets from the tagged
|
||||
revision.
|
||||
|
||||
## Reuse In Other Repositories
|
||||
## Use In Other Repositories
|
||||
|
||||
Vociferate ships two composite actions that together cover the full release flow.
|
||||
Pin both to the same released tag.
|
||||
@@ -34,13 +34,7 @@ jobs:
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Resolve cache token
|
||||
id: cache-token
|
||||
run: echo "value=${GITHUB_SHA}" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- uses: git.hrafn.xyz/aether/vociferate/prepare@v1.0.0
|
||||
env:
|
||||
VOCIFERATE_CACHE_TOKEN: ${{ steps.cache-token.outputs.value }}
|
||||
with:
|
||||
version: ${{ inputs.version }}
|
||||
```
|
||||
@@ -54,8 +48,6 @@ and `version-pattern`:
|
||||
|
||||
```yaml
|
||||
- uses: git.hrafn.xyz/aether/vociferate/prepare@v1.0.0
|
||||
env:
|
||||
VOCIFERATE_CACHE_TOKEN: ${{ github.sha }}
|
||||
with:
|
||||
version-file: internal/myapp/version/version.go
|
||||
version-pattern: 'const Version = "([^"]+)"'
|
||||
|
||||
Reference in New Issue
Block a user