docs: remove deleted release tag references
All checks were successful
Push Validation / validate (push) Successful in 1m48s

This commit is contained in:
Micheal Wilkinson
2026-03-20 23:12:01 +00:00
parent fd23a8b238
commit 6bcc027076
2 changed files with 6 additions and 18 deletions

View File

@@ -17,7 +17,7 @@ revision.
## Use In Other Repositories
Vociferate ships two composite actions that together cover the full release flow.
Pin both to the same released tag.
Until release tags are created, reference `@main`. Once tags exist again, pin both actions to the same released tag.
### `prepare` — update files, commit, and push tag
@@ -39,7 +39,7 @@ jobs:
with:
fetch-depth: 0
- uses: git.hrafn.xyz/aether/vociferate/prepare@v1.0.0
- uses: git.hrafn.xyz/aether/vociferate/prepare@main
with:
version: ${{ inputs.version }}
@@ -59,7 +59,7 @@ For repositories that embed the version inside source code, pass `version-file`
and `version-pattern`:
```yaml
- uses: git.hrafn.xyz/aether/vociferate/prepare@v1.0.0
- uses: git.hrafn.xyz/aether/vociferate/prepare@main
with:
version-file: internal/myapp/version/version.go
version-pattern: 'const Version = "([^"]+)"'
@@ -98,7 +98,7 @@ assets after it runs:
```yaml
- id: publish
uses: git.hrafn.xyz/aether/vociferate/publish@v1.0.0
uses: git.hrafn.xyz/aether/vociferate/publish@main
- name: Upload my binary
run: |
@@ -167,12 +167,7 @@ Defaults:
When no `--version-file` flag is provided, `vociferate` derives the current version from the most recent released section heading in the changelog (`## [x.y.z] - ...`). If no prior releases exist, it defaults to `0.0.0` and recommends `v1.0.0` as the first tag.
During prepare, vociferate also normalizes changelog heading links when it can determine the repository URL (from CI environment variables or `origin` git remote):
- `## [Unreleased]` becomes a link to the repository main branch.
- `## [x.y.z] - YYYY-MM-DD` becomes a link to the corresponding release page.
If the repository URL cannot be determined, headings remain in plain form.
During prepare, vociferate can normalize changelog heading links when it can determine the repository URL (from CI environment variables or `origin` git remote). If you prefer changelog headings to stay plain while tags are being rebuilt, leave the changelog as plain headings and avoid retaining historical release-tag links.
When running `--version`, the `release-version` file is created automatically if it does not exist, so new repositories do not need to pre-seed it.