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

docs: pin README examples to release tags

Browse Source
This commit is contained in:
Micheal Wilkinson
2026-03-21 00:20:08 +00:00
parent 16274ea1e5
commit 7d6ae6f486
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -17,7 +17,7 @@ revision.
## Use In Other Repositories
Vociferate ships three composite actions covering release preparation, release publication, and coverage badge publishing.
Until release tags are created, reference `@main`. Once tags exist again, pin all actions to the same released tag.
Release tags now exist; pin all action and reusable-workflow references to the same released tag (for example, `@v0.2.0`) instead of `@main`.
### `prepare` — update files, commit, and push tag
@@ -39,13 +39,13 @@ jobs:
with:
fetch-depth: 0
- uses: git.hrafn.xyz/aether/vociferate/prepare@main
- uses: git.hrafn.xyz/aether/vociferate/prepare@v0.2.0
with:
version: ${{ inputs.version }}
publish:
needs: prepare
uses: aether/vociferate/.gitea/workflows/do-release.yml@main
uses: aether/vociferate/.gitea/workflows/do-release.yml@v0.2.0
with:
tag: ${{ needs.prepare.outputs.version }}
secrets: inherit
@@ -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@main
- uses: git.hrafn.xyz/aether/vociferate/prepare@v0.2.0
with:
version-file: internal/myapp/version/version.go
version-pattern: 'const Version = "([^"]+)"'
@@ -83,7 +83,7 @@ on:
jobs:
release:
uses: aether/vociferate/.gitea/workflows/do-release.yml@main
uses: aether/vociferate/.gitea/workflows/do-release.yml@v0.2.0
with:
tag: ${{ inputs.tag }}
secrets: inherit
@@ -98,7 +98,7 @@ assets after it runs:
```yaml
- id: publish
uses: git.hrafn.xyz/aether/vociferate/publish@main
uses: git.hrafn.xyz/aether/vociferate/publish@v0.2.0
- name: Upload my binary
run: |
@@ -118,7 +118,7 @@ Run your coverage tests first, then call the action to generate `coverage.html`,
run: go test -covermode=atomic -coverprofile=coverage.out ./...
- id: coverage
uses: git.hrafn.xyz/aether/vociferate/coverage-badge@main
uses: git.hrafn.xyz/aether/vociferate/coverage-badge@v0.2.0
with:
artefact-bucket-name: ${{ vars.ARTEFACT_BUCKET_NAME }}
artefact-bucket-endpoint: ${{ vars.ARTEFACT_BUCKET_ENDPONT }}