aether/vociferate
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 7 Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -17,7 +17,7 @@ revision.
## Use In Other Repositories ## Use In Other Repositories
Vociferate ships two composite actions that together cover the full release flow. 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 ### `prepare` — update files, commit, and push tag
@@ -39,7 +39,7 @@ jobs:
with: with:
fetch-depth: 0 fetch-depth: 0
- uses: git.hrafn.xyz/aether/vociferate/prepare@v1.0.0 - uses: git.hrafn.xyz/aether/vociferate/prepare@main
with: with:
version: ${{ inputs.version }} version: ${{ inputs.version }}
@@ -59,7 +59,7 @@ For repositories that embed the version inside source code, pass `version-file`
and `version-pattern`: and `version-pattern`:
```yaml ```yaml
- uses: git.hrafn.xyz/aether/vociferate/prepare@v1.0.0 - uses: git.hrafn.xyz/aether/vociferate/prepare@main
with: with:
version-file: internal/myapp/version/version.go version-file: internal/myapp/version/version.go
version-pattern: 'const Version = "([^"]+)"' version-pattern: 'const Version = "([^"]+)"'
@@ -98,7 +98,7 @@ assets after it runs:
```yaml ```yaml
- id: publish - id: publish
uses: git.hrafn.xyz/aether/vociferate/publish@v1.0.0 uses: git.hrafn.xyz/aether/vociferate/publish@main
- name: Upload my binary - name: Upload my binary
run: | 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. 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): 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.
- `## [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.
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. 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.

9
changelog.md
View File

@@ -7,14 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
A `### Breaking` section is used in addition to Keep a Changelog's standard sections to explicitly document changes that are backwards-incompatible but would otherwise appear under `### Changed`. Entries under `### Breaking` trigger a major version bump in automated release recommendation logic. A `### Breaking` section is used in addition to Keep a Changelog's standard sections to explicitly document changes that are backwards-incompatible but would otherwise appear under `### Changed`. Entries under `### Breaking` trigger a major version bump in automated release recommendation logic.
## [Unreleased](http://teapot:3000/aether/vociferate/src/branch/main) ## [Unreleased]
### Changed ### Changed
- README workflow badges now link to the latest workflow run pages instead of the workflow definition pages. - README workflow badges now link to the latest workflow run pages instead of the workflow definition pages.
## [1.1.0](http://teapot:3000/aether/vociferate/releases/tag/v1.1.0) - 2026-03-20
### Fixed ### Fixed
- Publish action falls back to `git describe` when `inputs.version` is empty and `GITHUB_REF` is not a tag ref, resolving `workflow_call` input propagation failures in act runner v0.3.0. - Publish action falls back to `git describe` when `inputs.version` is empty and `GITHUB_REF` is not a tag ref, resolving `workflow_call` input propagation failures in act runner v0.3.0.
@@ -25,11 +23,6 @@ A `### Breaking` section is used in addition to Keep a Changelog's standard sect
- S3 coverage artefact publishing (HTML report, badge, JSON summary) in push validation pipeline. - S3 coverage artefact publishing (HTML report, badge, JSON summary) in push validation pipeline.
- CLI tests and internal helper tests raising total coverage to 84%. - CLI tests and internal helper tests raising total coverage to 84%.
- Test suite isolation against ambient CI environment variables for changelog link generation tests. - Test suite isolation against ambient CI environment variables for changelog link generation tests.
## [1.0.0](http://teapot:3000/aether/vociferate/releases/tag/v1.0.0) - 2026-03-20
### Added
- Go CLI for changelog-driven release preparation and semantic version recommendation. - Go CLI for changelog-driven release preparation and semantic version recommendation.
- Version recommendation from changelog release headings, including first-release support (`0.0.0` base -> `v1.0.0`). - Version recommendation from changelog release headings, including first-release support (`0.0.0` base -> `v1.0.0`).
- Automatic `release-version` creation/update during release preparation. - Automatic `release-version` creation/update during release preparation.