docs: refresh README wording and stylization

feat: sync docs action tags during prepare
refactor: normalize changelog filename docs
2026-03-21 00:48:46 +00:00 · 2026-03-21 00:29:14 +00:00 · 2026-03-21 00:27:32 +00:00 · 2026-03-21 00:27:18 +00:00 · 2026-03-21 00:26:43 +00:00 · 2026-03-21 00:20:08 +00:00
13 changed files with 508 additions and 113 deletions
--- a/.gitea/workflows/prepare-release.yml
+++ b/.gitea/workflows/prepare-release.yml
@@ -46,13 +46,39 @@ jobs:
        id: cache-token
        run: echo "value=${GITHUB_SHA}" >> "$GITHUB_OUTPUT"

+      - name: Resolve release tag
+        id: resolve-version
+        run: |
+          set -euo pipefail
+
+          provided_version="$(printf '%s' "${{ inputs.version }}" | sed 's/^[[:space:]]\+//; s/[[:space:]]\+$//')"
+          if [[ -z "$provided_version" ]]; then
+            release_tag="$(go run ./cmd/vociferate --recommend --root .)"
+          elif [[ "$provided_version" == v* ]]; then
+            release_tag="$provided_version"
+          else
+            release_tag="v${provided_version}"
+          fi
+
+          echo "tag=${release_tag}" >> "$GITHUB_OUTPUT"
+
+      - name: Update agent docs action tags
+        run: |
+          set -euo pipefail
+
+          release_tag="${{ steps.resolve-version.outputs.tag }}"
+          for file in README.md AGENTS.md; do
+            sed -E -i "s/@v[0-9]+\.[0-9]+\.[0-9]+/@${release_tag}/g" "$file"
+          done
+
      - name: Prepare and tag release
        id: prepare
        uses: ./prepare
        env:
          VOCIFERATE_CACHE_TOKEN: ${{ steps.cache-token.outputs.value }}
        with:
-          version: ${{ inputs.version }}
+          version: ${{ steps.resolve-version.outputs.tag }}
+          git-add-files: CHANGELOG.md release-version README.md AGENTS.md

      - name: Summarize prepared release
        run: |
--- a/.gitea/workflows/push-validation.yml
+++ b/.gitea/workflows/push-validation.yml
@@ -8,7 +8,7 @@ on:
      - "*"

 jobs:
-  validate:
+  coverage-badge:
    runs-on: ubuntu-latest
    container: docker.io/catthehacker/ubuntu:act-latest
    defaults:
@@ -35,96 +35,57 @@ jobs:
          cache: true
          cache-dependency-path: go.sum

-      - name: Install AWS CLI v2
-        uses: ankurk91/install-aws-cli-action@v1
-
-      - name: Verify AWS CLI
-        run: aws --version
-
      - name: Run full unit test suite with coverage
-        id: coverage
        run: |
          set -euo pipefail

          go test -covermode=atomic -coverprofile=coverage.out ./...
-          go tool cover -html=coverage.out -o coverage.html

-          total="$(go tool cover -func=coverage.out | awk '/^total:/ {sub(/%/, "", $3); print $3}')"
-          printf '{\n  "total": "%s"\n}\n' "$total" > coverage-summary.json
-          printf 'total=%s\n' "$total" >> "$GITHUB_OUTPUT"
+      - name: Publish coverage badge artefacts
+        id: coverage
+        uses: ./coverage-badge
+        with:
+          artefact-bucket-name: ${{ vars.ARTEFACT_BUCKET_NAME }}
+          artefact-bucket-endpoint: ${{ vars.ARTEFACT_BUCKET_ENDPONT }}
+          summary-file: ${{ env.SUMMARY_FILE }}

-      - name: Generate coverage badge
-        env:
-          COVERAGE_TOTAL: ${{ steps.coverage.outputs.total }}
+      - name: Summary
+        if: ${{ always() }}
        run: |
          set -euo pipefail

-          color="$(awk -v total="$COVERAGE_TOTAL" 'BEGIN {
-            if (total >= 80) print "brightgreen";
-            else if (total >= 70) print "green";
-            else if (total >= 60) print "yellowgreen";
-            else if (total >= 50) print "yellow";
-            else print "red";
-          }')"
+          echo 'Summary'
+          echo

-          cat > coverage-badge.svg <<EOF
-          <svg xmlns="http://www.w3.org/2000/svg" width="126" height="20" role="img" aria-label="coverage: ${COVERAGE_TOTAL}%">
-            <linearGradient id="smooth" x2="0" y2="100%">
-              <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
-              <stop offset="1" stop-opacity=".1"/>
-            </linearGradient>
-            <clipPath id="round">
-              <rect width="126" height="20" rx="3" fill="#fff"/>
-            </clipPath>
-            <g clip-path="url(#round)">
-              <rect width="63" height="20" fill="#555"/>
-              <rect x="63" width="63" height="20" fill="${color}"/>
-              <rect width="126" height="20" fill="url(#smooth)"/>
-            </g>
-            <g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
-              <text x="32.5" y="15" fill="#010101" fill-opacity=".3">coverage</text>
-              <text x="32.5" y="14">coverage</text>
-              <text x="93.5" y="15" fill="#010101" fill-opacity=".3">${COVERAGE_TOTAL}%</text>
-              <text x="93.5" y="14">${COVERAGE_TOTAL}%</text>
-            </g>
-          </svg>
-          EOF
+          if [[ -s "$SUMMARY_FILE" ]]; then
+            cat "$SUMMARY_FILE"
+          else
+            echo 'No summary generated.'
+          fi

-      - name: Upload branch coverage artefacts
-        id: upload
-        run: |
-          set -euo pipefail
+  recommend-release:
+    runs-on: ubuntu-latest
+    container: docker.io/catthehacker/ubuntu:act-latest
+    needs: coverage-badge
+    if: ${{ github.ref == 'refs/heads/main' }}
+    defaults:
+      run:
+        shell: bash
+    env:
+      SUMMARY_FILE: ${{ runner.temp }}/push-validation-recommend-summary.md
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4

-          aws configure set default.s3.addressing_style path
-
-          repo_name="${GITHUB_REPOSITORY##*/}"
-          prefix="${repo_name}/branch/${GITHUB_REF_NAME}"
-          display_endpoint="${ARTEFACT_BUCKET_ENDPONT#https://}"
-          display_endpoint="${display_endpoint#http://}"
-          report_url="//${display_endpoint%/}/${ARTEFACT_BUCKET_NAME}/${prefix}/coverage.html"
-          badge_url="//${display_endpoint%/}/${ARTEFACT_BUCKET_NAME}/${prefix}/coverage-badge.svg"
-
-          aws --endpoint-url "${ARTEFACT_BUCKET_ENDPONT}" s3 cp coverage.html "s3://${ARTEFACT_BUCKET_NAME}/${prefix}/coverage.html" --content-type text/html
-          aws --endpoint-url "${ARTEFACT_BUCKET_ENDPONT}" s3 cp coverage-badge.svg "s3://${ARTEFACT_BUCKET_NAME}/${prefix}/coverage-badge.svg" --content-type image/svg+xml
-          aws --endpoint-url "${ARTEFACT_BUCKET_ENDPONT}" s3 cp coverage-summary.json "s3://${ARTEFACT_BUCKET_NAME}/${prefix}/coverage-summary.json" --content-type application/json
-
-          printf 'report_url=%s\n' "$report_url" >> "$GITHUB_OUTPUT"
-          printf 'badge_url=%s\n' "$badge_url" >> "$GITHUB_OUTPUT"
-
-      - name: Add coverage summary
-        run: |
-          set -euo pipefail
-
-          {
-            echo '## Coverage'
-            echo
-            echo '- Total: `${{ steps.coverage.outputs.total }}%`'
-            echo '- Report: ${{ steps.upload.outputs.report_url }}'
-            echo '- Badge: ${{ steps.upload.outputs.badge_url }}'
-          } >> "$SUMMARY_FILE"
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.26.1'
+          check-latest: true
+          cache: true
+          cache-dependency-path: go.sum

      - name: Recommend next release tag on main pushes
-        if: ${{ github.ref == 'refs/heads/main' }}
        run: |
          set -euo pipefail

--- a/AGENTS.md
+++ b/AGENTS.md
@@ -0,0 +1,197 @@
+# Agent Integration Guide
+
+This guide is for agentic coding partners that need to integrate the composite actions published by this repository.
+
+## Source Of Truth
+
+Pin all action references to a released tag (for example `@v0.2.0`) and keep all vociferate references on the same tag in a workflow.
+
+Published composite actions:
+
+- `git.hrafn.xyz/aether/vociferate@v0.2.0` (root action)
+- `git.hrafn.xyz/aether/vociferate/prepare@v0.2.0`
+- `git.hrafn.xyz/aether/vociferate/publish@v0.2.0`
+- `git.hrafn.xyz/aether/vociferate/coverage-badge@v0.2.0`
+
+## Action Selection Matrix
+
+Use this when deciding which action to call:
+
+- Choose `prepare` when you need to update changelog/version files, commit, and push a release tag.
+- Choose `publish` when a tag already exists and you need to create or update release notes/assets.
+- Choose `coverage-badge` after tests have produced `coverage.out` and you need coverage artefacts uploaded.
+- Choose root `vociferate` for direct recommend/prepare logic without commit/tag/push behavior.
+
+## Preconditions
+
+Apply these checks before invoking actions:
+
+- Checkout repository first.
+- For prepare/publish flows that depend on tags/history, use full history checkout (`fetch-depth: 0`).
+- Use valid credentials in `github.token` (or explicit token input for `publish` when needed).
+- Set required vars/secrets for coverage uploads:
+  - `vars.ARTEFACT_BUCKET_NAME`
+  - `vars.ARTEFACT_BUCKET_ENDPONT`
+  - `secrets.ARTEFACT_BUCKET_WRITE_ACCESS_KEY`
+  - `secrets.ARTEFACT_BUCKET_WRITE_ACCESS_SECRET`
+- For externally visible changelog links, set `vars.VOCIFERATE_REPOSITORY_URL` to the server/base URL only.
+
+## Changelog Format Guidance
+
+Agents should keep `CHANGELOG.md` in a Keep a Changelog compatible structure because vociferate derives versions and release notes from headings.
+
+Required conventions:
+
+- Keep the top-level heading as `# Changelog`.
+- Maintain an `## [Unreleased]` section.
+- Keep the standard subsections under `Unreleased` in this order:
+  - `### Breaking`
+  - `### Added`
+  - `### Changed`
+  - `### Removed`
+  - `### Fixed`
+- Record releases with headings like `## [1.2.3] - YYYY-MM-DD`.
+- Use bullet entries under subsections (for example `- Added new publish output`).
+- Preserve or regenerate bottom reference links (`[Unreleased]: ...`, `[1.2.3]: ...`) instead of mixing inline heading links.
+
+Semver behavior used by recommendation logic:
+
+- `Breaking` or `Removed` entries trigger a major bump.
+- `Added` entries trigger a minor bump.
+- Otherwise recommendation falls back to a patch bump.
+
+Minimal template:
+
+```markdown
+# Changelog
+
+## [Unreleased]
+
+### Breaking
+
+### Added
+
+### Changed
+
+### Removed
+
+### Fixed
+```
+
+## Minimal Integration Patterns
+
+### 1. Prepare Then Publish
+
+```yaml
+jobs:
+  prepare:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - id: prepare
+        uses: git.hrafn.xyz/aether/vociferate/prepare@v0.2.0
+
+  publish:
+    needs: prepare
+    uses: aether/vociferate/.gitea/workflows/do-release.yml@v0.2.0
+    with:
+      tag: ${{ needs.prepare.outputs.version }}
+    secrets: inherit
+```
+
+### 2. Publish Existing Tag
+
+```yaml
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - id: publish
+        uses: git.hrafn.xyz/aether/vociferate/publish@v0.2.0
+        with:
+          version: v1.2.3
+```
+
+### 3. Coverage Badge Publication
+
+```yaml
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    env:
+      AWS_ACCESS_KEY_ID: ${{ secrets.ARTEFACT_BUCKET_WRITE_ACCESS_KEY }}
+      AWS_SECRET_ACCESS_KEY: ${{ secrets.ARTEFACT_BUCKET_WRITE_ACCESS_SECRET }}
+      AWS_DEFAULT_REGION: ${{ vars.ARTEFACT_BUCKET_REGION }}
+      AWS_EC2_METADATA_DISABLED: true
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run tests with coverage
+        run: go test -covermode=atomic -coverprofile=coverage.out ./...
+      - id: badge
+        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 }}
+```
+
+## Inputs And Outputs Cheatsheet
+
+### prepare
+
+Common inputs:
+
+- `version` (optional override)
+- `version-file` (optional)
+- `version-pattern` (optional)
+- `changelog` (optional)
+
+Primary output:
+
+- `version` (resolved tag, for example `v1.2.3`)
+
+### publish
+
+Common inputs:
+
+- `token` (optional, defaults to workflow token)
+- `version` (optional if running from tag ref)
+- `changelog` (optional)
+
+Primary outputs:
+
+- `release-id`
+- `tag`
+- `version`
+
+### coverage-badge
+
+Required inputs:
+
+- `artefact-bucket-name`
+- `artefact-bucket-endpoint`
+
+Useful optional inputs:
+
+- `coverage-profile` (default `coverage.out`)
+- `summary-file` (append markdown summary)
+
+Primary outputs:
+
+- `total`
+- `report-url`
+- `badge-url`
+
+## Guardrails For Agents
+
+Use these rules to avoid common automation mistakes:
+
+- Do not mix action tags in one workflow update.
+- Do not assume a release workflow will run from a tag push in all environments; reusable workflow call paths are supported.
+- Do not treat `VOCIFERATE_REPOSITORY_URL` as a full repository URL; it must be a base URL.
+- Keep displayed URLs protocol-relative (`//`) when writing markdown/browser-facing outputs.
+- If a workflow environment does not support `GITHUB_STEP_SUMMARY`, append markdown to a file and print it in a final `Summary` step.
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -15,6 +15,9 @@ A `### Breaking` section is used in addition to Keep a Changelog's standard sect

 ### Changed

+- Canonical changelog filename is now `CHANGELOG.md`, and action/code defaults were updated to match.
+- README now uses `Æther` stylization in prose and corrects released-tag guidance wording.
+
 ### Removed

 ### Fixed
@@ -27,9 +30,14 @@ A `### Breaking` section is used in addition to Keep a Changelog's standard sect

 - Added a project LICENSE file.
 - Root and prepare actions now read `${{ vars.VOCIFERATE_REPOSITORY_URL }}` and forward it to `VOCIFERATE_REPOSITORY_URL` for repository URL override.
+- Added a published `coverage-badge` composite action for generating and uploading coverage report/badge artefacts for reuse across repositories.
+- Added `AGENTS.md`, an explicit integration guide for agentic coding partners using vociferate composite actions.

 ### Changed

+- Push validation now handles coverage artefact and badge generation in a dedicated `coverage-badge` job, with release recommendation isolated in a separate dependent job.
+- Push validation now calls the reusable `./coverage-badge` composite action for coverage badge generation and publication.
+
 ### Removed

 ### Fixed
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@
 [![Do Release](//git.hrafn.xyz/aether/vociferate/actions/workflows/do-release.yml/badge.svg?event=push)](//git.hrafn.xyz/aether/vociferate/actions/runs/latest?workflow=do-release.yml)
 [![Coverage](//s3.hrafn.xyz/aether-workflow-report-artefacts/vociferate/branch/main/coverage-badge.svg)](//s3.hrafn.xyz/aether-workflow-report-artefacts/vociferate/branch/main/coverage.html)

-`vociferate` is an `aether` release orchestration tool written in Go for repositories that
+`vociferate` is an `Æther` release orchestration tool written in Go for repositories that
 want changelog-driven versioning, automated release preparation, and repeatable
 tag publication.

@@ -16,8 +16,10 @@ revision.

 ## Use In Other Repositories

-Vociferate ships two composite actions that together cover the full release flow.
-Until release tags are created, reference `@main`. Once tags exist again, pin both actions to the same released tag.
+Vociferate ships three composite actions covering release preparation, release publication, and coverage badge publishing.
+Release tags now exist; pin all action and reusable-workflow references to the same released tag (for example, `@v0.2.0`) instead of `@main`.
+
+For agentic coding partners, see [`AGENTS.md`](AGENTS.md) for a direct integration playbook, selection matrix, and copy-paste workflow patterns.

 ### `prepare` — update files, commit, and push tag

@@ -39,19 +41,19 @@ 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
 ```

-Downloads a prebuilt vociferate binary, runs it to update `changelog.md` and
+Downloads a prebuilt vociferate binary, runs it to update `CHANGELOG.md` and
 `release-version`, then commits those changes to the default branch and pushes
 the release tag. Does not require Go on the runner.

@@ -59,11 +61,11 @@ 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 = "([^"]+)"'
-    git-add-files: changelog.md internal/myapp/version/version.go
+    git-add-files: CHANGELOG.md internal/myapp/version/version.go
 ```

 `prepare` uses `github.token` internally for authenticated fetch/push operations,
@@ -83,13 +85,13 @@ 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
 ```

-Reads the matching section from `changelog.md` and creates or updates the
+Reads the matching section from `CHANGELOG.md` and creates or updates the
 Gitea/GitHub release with those notes. The `version` input is optional — when
 omitted it is derived from the current tag ref automatically.

@@ -98,7 +100,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: |
@@ -109,6 +111,26 @@ assets after it runs:
      --data-binary "@dist/myapp"
 ```

+### `coverage-badge` - publish coverage report and badge
+
+Run your coverage tests first, then call the action to generate `coverage.html`, `coverage-badge.svg`, and `coverage-summary.json`, upload them to S3-compatible storage, and emit output URLs.
+
+```yaml
+- name: Run tests with coverage
+  run: go test -covermode=atomic -coverprofile=coverage.out ./...
+
+- id: coverage
+  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 }}
+
+- name: Print coverage links
+  run: |
+    echo "Report: ${{ steps.coverage.outputs.report-url }}"
+    echo "Badge: ${{ steps.coverage.outputs.badge-url }}"
+```
+
 ## Why The Name

 > **vociferate** _(verb)_: to cry out loudly or forcefully.
@@ -163,7 +185,7 @@ Defaults:

 - `version-file`: `release-version`
 - `version-pattern`: `^\s*([^\r\n]+)\s*$`
- `changelog`: `changelog.md`
+- `changelog`: `CHANGELOG.md`

 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.

@@ -183,7 +205,7 @@ just go-test

 Releases use two workflows:

- `Prepare Release` runs on demand, updates `release-version` and `changelog.md`, commits those changes back to `main`, and pushes the release tag.
+- `Prepare Release` runs on demand, updates `release-version` and `CHANGELOG.md`, commits those changes back to `main`, and pushes the release tag.
 - `Prepare Release` then calls `Do Release` directly via reusable `workflow_call` with the resolved tag.
 - `Do Release` reads the matching changelog section from that tagged revision, creates or updates the release, and uploads prebuilt binaries.

--- a/action.yml
+++ b/action.yml
@@ -16,7 +16,7 @@ inputs:
  changelog:
    description: Path to changelog file relative to repository root.
    required: false
-    default: changelog.md
+    default: CHANGELOG.md
  recommend:
    description: If true, print recommended next release tag.
    required: false
--- a/cmd/vociferate/main_test.go
+++ b/cmd/vociferate/main_test.go
@@ -12,7 +12,7 @@ import (
 func TestMainRecommendPrintsTag(t *testing.T) {
 	root := t.TempDir()
 	writeFile(t, filepath.Join(root, "release-version"), "1.1.6\n")
-	writeFile(t, filepath.Join(root, "changelog.md"), "# Changelog\n\n## [Unreleased]\n\n### Added\n\n- Feature.\n\n## [1.1.6] - 2017-12-20\n")
+	writeFile(t, filepath.Join(root, "CHANGELOG.md"), "# Changelog\n\n## [Unreleased]\n\n### Added\n\n- Feature.\n\n## [1.1.6] - 2017-12-20\n")

 	stdout, stderr, code := runMain(t, "--recommend", "--root", root)
 	if code != 0 {
@@ -37,7 +37,7 @@ func TestMainPrepareUpdatesFiles(t *testing.T) {
 	root := t.TempDir()
 	writeFile(t, filepath.Join(root, ".git", "config"), "[remote \"origin\"]\n\turl = git@git.hrafn.xyz:aether/vociferate.git\n")
 	writeFile(t, filepath.Join(root, "release-version"), "1.1.6\n")
-	writeFile(t, filepath.Join(root, "changelog.md"), "# Changelog\n\n## [Unreleased]\n\n### Fixed\n\n- Patch note.\n\n## [1.1.6] - 2017-12-20\n")
+	writeFile(t, filepath.Join(root, "CHANGELOG.md"), "# Changelog\n\n## [Unreleased]\n\n### Fixed\n\n- Patch note.\n\n## [1.1.6] - 2017-12-20\n")

 	_, stderr, code := runMain(t, "--version", "v1.1.7", "--date", "2026-03-20", "--root", root)
 	if code != 0 {
--- a/coverage-badge/action.yml
+++ b/coverage-badge/action.yml
@@ -0,0 +1,168 @@
+name: vociferate/coverage-badge
+description: >
+  Generate coverage report artefacts, publish them to object storage,
+  and expose report URLs for workflow summaries.
+
+inputs:
+  coverage-profile:
+    description: Path to the Go coverage profile file.
+    required: false
+    default: coverage.out
+  coverage-html:
+    description: Output path for the rendered HTML coverage report.
+    required: false
+    default: coverage.html
+  coverage-badge:
+    description: Output path for the generated SVG badge.
+    required: false
+    default: coverage-badge.svg
+  coverage-summary:
+    description: Output path for the generated coverage summary JSON.
+    required: false
+    default: coverage-summary.json
+  artefact-bucket-name:
+    description: S3 bucket name for published coverage artefacts.
+    required: true
+  artefact-bucket-endpoint:
+    description: Endpoint URL used for S3-compatible uploads.
+    required: true
+  branch-name:
+    description: Branch name used in the publication path.
+    required: false
+    default: ''
+  repository-name:
+    description: Repository name used in the publication path.
+    required: false
+    default: ''
+  summary-file:
+    description: Optional file path to append markdown summary output.
+    required: false
+    default: ''
+
+outputs:
+  total:
+    description: Computed coverage percentage.
+    value: ${{ steps.generate.outputs.total }}
+  report-url:
+    description: Browser-facing URL for the published coverage report.
+    value: ${{ steps.upload.outputs.report_url }}
+  badge-url:
+    description: Browser-facing URL for the published coverage badge.
+    value: ${{ steps.upload.outputs.badge_url }}
+
+runs:
+  using: composite
+  steps:
+    - name: Install AWS CLI v2
+      uses: ankurk91/install-aws-cli-action@v1
+
+    - name: Verify AWS CLI
+      shell: bash
+      run: aws --version
+
+    - name: Generate coverage artefacts
+      id: generate
+      shell: bash
+      env:
+        COVERAGE_PROFILE: ${{ inputs.coverage-profile }}
+        COVERAGE_HTML: ${{ inputs.coverage-html }}
+        COVERAGE_BADGE: ${{ inputs.coverage-badge }}
+        COVERAGE_SUMMARY: ${{ inputs.coverage-summary }}
+      run: |
+        set -euo pipefail
+
+        go tool cover -html="$COVERAGE_PROFILE" -o "$COVERAGE_HTML"
+
+        total="$(go tool cover -func="$COVERAGE_PROFILE" | awk '/^total:/ {sub(/%/, "", $3); print $3}')"
+        printf '{\n  "total": "%s"\n}\n' "$total" > "$COVERAGE_SUMMARY"
+        printf 'total=%s\n' "$total" >> "$GITHUB_OUTPUT"
+
+        color="$(awk -v total="$total" 'BEGIN {
+          if (total >= 80) print "brightgreen";
+          else if (total >= 70) print "green";
+          else if (total >= 60) print "yellowgreen";
+          else if (total >= 50) print "yellow";
+          else print "red";
+        }')"
+
+        cat > "$COVERAGE_BADGE" <<EOF
+        <svg xmlns="http://www.w3.org/2000/svg" width="126" height="20" role="img" aria-label="coverage: ${total}%">
+          <linearGradient id="smooth" x2="0" y2="100%">
+            <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
+            <stop offset="1" stop-opacity=".1"/>
+          </linearGradient>
+          <clipPath id="round">
+            <rect width="126" height="20" rx="3" fill="#fff"/>
+          </clipPath>
+          <g clip-path="url(#round)">
+            <rect width="63" height="20" fill="#555"/>
+            <rect x="63" width="63" height="20" fill="${color}"/>
+            <rect width="126" height="20" fill="url(#smooth)"/>
+          </g>
+          <g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
+            <text x="32.5" y="15" fill="#010101" fill-opacity=".3">coverage</text>
+            <text x="32.5" y="14">coverage</text>
+            <text x="93.5" y="15" fill="#010101" fill-opacity=".3">${total}%</text>
+            <text x="93.5" y="14">${total}%</text>
+          </g>
+        </svg>
+        EOF
+
+    - name: Upload coverage artefacts
+      id: upload
+      shell: bash
+      env:
+        ARTEFACT_BUCKET_NAME: ${{ inputs.artefact-bucket-name }}
+        ARTEFACT_BUCKET_ENDPONT: ${{ inputs.artefact-bucket-endpoint }}
+        INPUT_BRANCH_NAME: ${{ inputs.branch-name }}
+        INPUT_REPOSITORY_NAME: ${{ inputs.repository-name }}
+        COVERAGE_HTML: ${{ inputs.coverage-html }}
+        COVERAGE_BADGE: ${{ inputs.coverage-badge }}
+        COVERAGE_SUMMARY: ${{ inputs.coverage-summary }}
+      run: |
+        set -euo pipefail
+
+        aws configure set default.s3.addressing_style path
+
+        branch_name="$(printf '%s' "$INPUT_BRANCH_NAME" | sed 's/^[[:space:]]\+//; s/[[:space:]]\+$//')"
+        if [[ -z "$branch_name" ]]; then
+          branch_name="${GITHUB_REF_NAME}"
+        fi
+
+        repo_name="$(printf '%s' "$INPUT_REPOSITORY_NAME" | sed 's/^[[:space:]]\+//; s/[[:space:]]\+$//')"
+        if [[ -z "$repo_name" ]]; then
+          repo_name="${GITHUB_REPOSITORY##*/}"
+        fi
+
+        prefix="${repo_name}/branch/${branch_name}"
+
+        display_endpoint="${ARTEFACT_BUCKET_ENDPONT#https://}"
+        display_endpoint="${display_endpoint#http://}"
+        report_url="//${display_endpoint%/}/${ARTEFACT_BUCKET_NAME}/${prefix}/coverage.html"
+        badge_url="//${display_endpoint%/}/${ARTEFACT_BUCKET_NAME}/${prefix}/coverage-badge.svg"
+
+        aws --endpoint-url "${ARTEFACT_BUCKET_ENDPONT}" s3 cp "$COVERAGE_HTML" "s3://${ARTEFACT_BUCKET_NAME}/${prefix}/coverage.html" --content-type text/html
+        aws --endpoint-url "${ARTEFACT_BUCKET_ENDPONT}" s3 cp "$COVERAGE_BADGE" "s3://${ARTEFACT_BUCKET_NAME}/${prefix}/coverage-badge.svg" --content-type image/svg+xml
+        aws --endpoint-url "${ARTEFACT_BUCKET_ENDPONT}" s3 cp "$COVERAGE_SUMMARY" "s3://${ARTEFACT_BUCKET_NAME}/${prefix}/coverage-summary.json" --content-type application/json
+
+        printf 'report_url=%s\n' "$report_url" >> "$GITHUB_OUTPUT"
+        printf 'badge_url=%s\n' "$badge_url" >> "$GITHUB_OUTPUT"
+
+    - name: Append coverage summary
+      if: ${{ inputs.summary-file != '' }}
+      shell: bash
+      env:
+        SUMMARY_FILE: ${{ inputs.summary-file }}
+        TOTAL: ${{ steps.generate.outputs.total }}
+        REPORT_URL: ${{ steps.upload.outputs.report_url }}
+        BADGE_URL: ${{ steps.upload.outputs.badge_url }}
+      run: |
+        set -euo pipefail
+
+        {
+          echo '## Coverage'
+          echo
+          echo "- Total: \`${TOTAL}%\`"
+          echo "- Report: ${REPORT_URL}"
+          echo "- Badge: ${BADGE_URL}"
+        } >> "$SUMMARY_FILE"
--- a/internal/vociferate/vociferate.go
+++ b/internal/vociferate/vociferate.go
@@ -19,7 +19,7 @@ import (
 const (
 	defaultVersionFile        = "release-version"
 	defaultVersionExpr        = `^\s*([^\r\n]+)\s*$`
-	defaultChangelog          = "changelog.md"
+	defaultChangelog          = "CHANGELOG.md"
 	defaultUnreleasedTemplate = "### Breaking\n\n### Added\n\n### Changed\n\n### Removed\n\n### Fixed\n"
 )

@@ -38,7 +38,7 @@ type Options struct {
 	// When empty, a line-oriented default matcher is used.
 	VersionPattern string
 	// Changelog is the path to the changelog file, relative to the repository
-	// root. When empty, changelog.md is used.
+	// root. When empty, CHANGELOG.md is used.
 	Changelog string
 }

--- a/internal/vociferate/vociferate_internal_test.go
+++ b/internal/vociferate/vociferate_internal_test.go
@@ -146,3 +146,16 @@ func TestDeriveRepositoryURL_UsesOverrideAsHighestPriority(t *testing.T) {
 		t.Fatalf("unexpected repository URL: %q", url)
 	}
 }
+
+func TestResolveOptions_UsesUppercaseChangelogDefault(t *testing.T) {
+	t.Parallel()
+
+	resolved, err := resolveOptions(Options{})
+	if err != nil {
+		t.Fatalf("resolveOptions returned unexpected error: %v", err)
+	}
+
+	if resolved.Changelog != "CHANGELOG.md" {
+		t.Fatalf("resolved changelog = %q, want %q", resolved.Changelog, "CHANGELOG.md")
+	}
+}
--- a/internal/vociferate/vociferate_test.go
+++ b/internal/vociferate/vociferate_test.go
@@ -41,7 +41,7 @@ func (s *PrepareSuite) SetupTest() {
 	))

 	require.NoError(s.T(), os.WriteFile(
-		filepath.Join(s.rootDir, "changelog.md"),
+		filepath.Join(s.rootDir, "CHANGELOG.md"),
 		[]byte("# Changelog\n\n## [Unreleased]\n\n### Breaking\n\n### Added\n\n- New thing.\n\n### Fixed\n\n- Old thing.\n\n## [1.1.6] - 2017-12-20\n\n### Fixed\n\n- Historical note.\n"),
 		0o644,
 	))
@@ -72,7 +72,7 @@ func (s *PrepareSuite) TestPrepare_UpdatesVersionAndPromotesUnreleasedNotes() {
 	require.NoError(s.T(), err)
 	require.Equal(s.T(), "1.1.7\n", string(versionBytes))

-	changelogBytes, err := os.ReadFile(filepath.Join(s.rootDir, "changelog.md"))
+	changelogBytes, err := os.ReadFile(filepath.Join(s.rootDir, "CHANGELOG.md"))
 	require.NoError(s.T(), err)
 	firstCommit := firstCommitShortHash(s.T(), s.rootDir)
 	require.Equal(s.T(), "# Changelog\n\n## [Unreleased]\n\n### Breaking\n\n### Added\n\n### Changed\n\n### Removed\n\n### Fixed\n\n## [1.1.7] - 2026-03-20\n\n### Breaking\n\n### Added\n\n- New thing.\n\n### Fixed\n\n- Old thing.\n\n## [1.1.6] - 2017-12-20\n\n### Fixed\n\n- Historical note.\n\n[Unreleased]: //git.hrafn.xyz/aether/vociferate/compare/v1.1.7...main\n[1.1.7]: //git.hrafn.xyz/aether/vociferate/compare/v1.1.6...v1.1.7\n[1.1.6]: //git.hrafn.xyz/aether/vociferate/compare/"+firstCommit+"...v1.1.6\n", string(changelogBytes))
@@ -80,7 +80,7 @@ func (s *PrepareSuite) TestPrepare_UpdatesVersionAndPromotesUnreleasedNotes() {

 func (s *PrepareSuite) TestPrepare_ReturnsErrorWhenUnreleasedSectionMissing() {
 	require.NoError(s.T(), os.WriteFile(
-		filepath.Join(s.rootDir, "changelog.md"),
+		filepath.Join(s.rootDir, "CHANGELOG.md"),
 		[]byte("# Changelog\n\n## [1.1.6] - 2017-12-20\n"),
 		0o644,
 	))
@@ -92,7 +92,7 @@ func (s *PrepareSuite) TestPrepare_ReturnsErrorWhenUnreleasedSectionMissing() {

 func (s *PrepareSuite) TestPrepare_ReturnsErrorWhenUnreleasedSectionIsEmpty() {
 	require.NoError(s.T(), os.WriteFile(
-		filepath.Join(s.rootDir, "changelog.md"),
+		filepath.Join(s.rootDir, "CHANGELOG.md"),
 		[]byte("# Changelog\n\n## [Unreleased]\n\n## [1.1.6] - 2017-12-20\n"),
 		0o644,
 	))
@@ -111,7 +111,7 @@ func (s *PrepareSuite) TestRecommendedTag_UsesMinorBumpWhenBreakingHeadingIsEmpt

 func (s *PrepareSuite) TestRecommendedTag_ReturnsErrorWhenUnreleasedHasOnlyTemplateHeadings() {
 	require.NoError(s.T(), os.WriteFile(
-		filepath.Join(s.rootDir, "changelog.md"),
+		filepath.Join(s.rootDir, "CHANGELOG.md"),
 		[]byte("# Changelog\n\n## [Unreleased]\n\n### Breaking\n\n### Added\n\n### Changed\n\n### Removed\n\n### Fixed\n\n## [1.1.6] - 2017-12-20\n"),
 		0o644,
 	))
@@ -123,7 +123,7 @@ func (s *PrepareSuite) TestRecommendedTag_ReturnsErrorWhenUnreleasedHasOnlyTempl

 func (s *PrepareSuite) TestRecommendedTag_UsesPatchBumpForFixOnlyChanges() {
 	require.NoError(s.T(), os.WriteFile(
-		filepath.Join(s.rootDir, "changelog.md"),
+		filepath.Join(s.rootDir, "CHANGELOG.md"),
 		[]byte("# Changelog\n\n## [Unreleased]\n\n### Fixed\n\n- Patch note.\n\n## [1.1.6] - 2017-12-20\n"),
 		0o644,
 	))
@@ -136,7 +136,7 @@ func (s *PrepareSuite) TestRecommendedTag_UsesPatchBumpForFixOnlyChanges() {

 func (s *PrepareSuite) TestRecommendedTag_UsesMajorBumpWhenRemovedEntriesExist() {
 	require.NoError(s.T(), os.WriteFile(
-		filepath.Join(s.rootDir, "changelog.md"),
+		filepath.Join(s.rootDir, "CHANGELOG.md"),
 		[]byte("# Changelog\n\n## [Unreleased]\n\n### Removed\n\n- Breaking removal.\n\n## [1.1.6] - 2017-12-20\n"),
 		0o644,
 	))
@@ -149,7 +149,7 @@ func (s *PrepareSuite) TestRecommendedTag_UsesMajorBumpWhenRemovedEntriesExist()

 func (s *PrepareSuite) TestRecommendedTag_UsesMajorBumpWhenBreakingEntriesExist() {
 	require.NoError(s.T(), os.WriteFile(
-		filepath.Join(s.rootDir, "changelog.md"),
+		filepath.Join(s.rootDir, "CHANGELOG.md"),
 		[]byte("# Changelog\n\n## [Unreleased]\n\n### Breaking\n\n- Changed API contract.\n\n### Changed\n\n- Updated defaults.\n\n## [1.1.6] - 2017-12-20\n"),
 		0o644,
 	))
@@ -206,7 +206,7 @@ func (s *PrepareSuite) TestRecommendedTag_UsesChangelogVersionWhenNoVersionFileC
 		0o644,
 	))
 	require.NoError(s.T(), os.WriteFile(
-		filepath.Join(s.rootDir, "changelog.md"),
+		filepath.Join(s.rootDir, "CHANGELOG.md"),
 		[]byte("# Changelog\n\n## [Unreleased]\n\n### Fixed\n\n- A fix.\n\n## [3.0.0] - 2026-01-01\n\n### Fixed\n\n- Historical.\n"),
 		0o644,
 	))
@@ -220,7 +220,7 @@ func (s *PrepareSuite) TestRecommendedTag_UsesChangelogVersionWhenNoVersionFileC
 func (s *PrepareSuite) TestRecommendedTag_DefaultsToV1WhenNoPriorReleasesInChangelog() {
 	require.NoError(s.T(), os.Remove(filepath.Join(s.rootDir, "release-version")))
 	require.NoError(s.T(), os.WriteFile(
-		filepath.Join(s.rootDir, "changelog.md"),
+		filepath.Join(s.rootDir, "CHANGELOG.md"),
 		[]byte("# Changelog\n\n## [Unreleased]\n\n### Breaking\n\n### Added\n\n- First feature.\n"),
 		0o644,
 	))
@@ -252,7 +252,7 @@ func (s *PrepareSuite) TestRecommendedTag_UsesCustomVersionFileAndPattern() {
 		0o644,
 	))
 	require.NoError(s.T(), os.WriteFile(
-		filepath.Join(s.rootDir, "changelog.md"),
+		filepath.Join(s.rootDir, "CHANGELOG.md"),
 		[]byte("# Changelog\n\n## [Unreleased]\n\n### Added\n\n- Feature.\n\n## [2.3.4] - 2026-03-10\n"),
 		0o644,
 	))
@@ -273,7 +273,7 @@ func (s *PrepareSuite) TestPrepare_UsesGitHrafnXYZEnvironmentForChangelogLinks()
 	err := vociferate.Prepare(s.rootDir, "1.1.7", "2026-03-20", vociferate.Options{})
 	require.NoError(s.T(), err)

-	changelogBytes, readErr := os.ReadFile(filepath.Join(s.rootDir, "changelog.md"))
+	changelogBytes, readErr := os.ReadFile(filepath.Join(s.rootDir, "CHANGELOG.md"))
 	require.NoError(s.T(), readErr)
 	changelog := string(changelogBytes)
 	firstCommit := firstCommitShortHash(s.T(), s.rootDir)
@@ -295,7 +295,7 @@ func (s *PrepareSuite) TestPrepare_UsesGitHubEnvironmentForChangelogLinks() {
 	err := vociferate.Prepare(s.rootDir, "1.1.7", "2026-03-20", vociferate.Options{})
 	require.NoError(s.T(), err)

-	changelogBytes, readErr := os.ReadFile(filepath.Join(s.rootDir, "changelog.md"))
+	changelogBytes, readErr := os.ReadFile(filepath.Join(s.rootDir, "CHANGELOG.md"))
 	require.NoError(s.T(), readErr)
 	changelog := string(changelogBytes)
 	firstCommit := firstCommitShortHash(s.T(), s.rootDir)
--- a/prepare/action.yml
+++ b/prepare/action.yml
@@ -26,7 +26,7 @@ inputs:
  changelog:
    description: Path to changelog file relative to repository root.
    required: false
-    default: changelog.md
+    default: CHANGELOG.md
  git-user-name:
    description: Name for the release commit author.
    required: false
@@ -38,10 +38,10 @@ inputs:
  git-add-files:
    description: >
      Space-separated list of file paths to stage for the release commit.
-      Defaults to changelog.md and release-version. Adjust when using a
+      Defaults to CHANGELOG.md and release-version. Adjust when using a
      custom version-file.
    required: false
-    default: 'changelog.md release-version'
+    default: 'CHANGELOG.md release-version'

 outputs:
  version:
--- a/publish/action.yml
+++ b/publish/action.yml
@@ -20,7 +20,7 @@ inputs:
  changelog:
    description: Path to changelog file relative to repository root.
    required: false
-    default: changelog.md
+    default: CHANGELOG.md

 outputs:
  release-id:
@@ -67,7 +67,7 @@ runs:
      id: extract-notes
      shell: bash
      env:
-        CHANGELOG: ${{ inputs.changelog != '' && inputs.changelog || 'changelog.md' }}
+        CHANGELOG: ${{ inputs.changelog != '' && inputs.changelog || 'CHANGELOG.md' }}
        RELEASE_VERSION: ${{ steps.resolve-version.outputs.version }}
        RUNNER_TEMP: ${{ runner.temp }}
      run: |
Author	SHA1	Message	Date
Micheal Wilkinson	e99527f68b	docs: refresh README wording and stylization All checks were successful Push Validation / coverage-badge (push) Successful in 1m43s Details Push Validation / recommend-release (push) Successful in 38s Details	2026-03-21 00:48:46 +00:00
Micheal Wilkinson	f314d7da1b	feat: sync docs action tags during prepare	2026-03-21 00:29:14 +00:00
Micheal Wilkinson	21a68647f3	refactor: normalize changelog filename docs	2026-03-21 00:27:32 +00:00
Micheal Wilkinson	ba715d9965	feat: migrate changelog path to CHANGELOG.md	2026-03-21 00:27:18 +00:00
Micheal Wilkinson	62f637614d	test: require CHANGELOG.md defaults	2026-03-21 00:26:43 +00:00
Micheal Wilkinson	7d6ae6f486	docs: pin README examples to release tags	2026-03-21 00:20:08 +00:00
Micheal Wilkinson	16274ea1e5	feat: add reusable coverage-badge action	2026-03-21 00:18:21 +00:00