Skip to content

docs: pin the reusable workflows to @latest in examples and guidance - #14

Merged
etirelli merged 1 commit into
mainfrom
docs/pin-latest
Nov 12, 2026
Merged

etirelli merged 1 commit into
mainfrom
docs/pin-latest

Conversation

@etirelli

Copy link
Copy Markdown
Contributor

What

The workflow examples pinned @v0.1.0, a tag that does not exist (the releases are v1.0.0 and v2.0.0), so a copied example failed the pin check. All examples and documentation now pin the reusable workflows to @latest.

Changes

  • Examples: the OpenAPI, coverage, CRD, and consumer workflow examples use @latest.
  • Guidance: releasing.md makes latest the default choice. The onboarding guides, the READMEs, and both onboarding skills recommend @latest. A version tag, stable, and a full commit SHA are still listed as supported alternatives; branches remain rejected.
  • Wording removed: "a version tag is the default for an enforced check; @latest does not suit one" and "latest: not for gates". These contradicted the new examples, which is the inconsistency flagged on feat: make mode: enforce the default everywhere #13.
  • Kept: the release procedure in releasing.md keeps v0.1.0 as the placeholder for the version being released. The pinning table's version-tag row still shows a version tag as its example.

Trade-off for reviewers

With @latest, every release reaches callers without a change in their repository. In enforce mode, a release that reports new findings can start failing pull requests. releasing.md now says this and asks callers to read the release notes. Callers that need nothing to change between upgrades can still pin a version tag.

Docs only. git diff --check passes, and no headings or anchors changed.

🤖 Generated with Claude Code

The workflow examples pinned @v0.1.0, a tag that does not exist, so a
copied example failed. Every example now uses @latest, and the guidance
says so:

- releasing.md makes `latest` the default choice, with the trade-off
  that a new release can start failing pull requests in enforce mode.
  A version tag, `stable`, and a full SHA remain supported.
- The onboarding guides, READMEs, and both onboarding skills recommend
  @latest and drop the "a version tag is the default; @latest does not
  suit an enforced check" wording, so examples and guidance agree.

The release procedure in releasing.md keeps v0.1.0 as the placeholder
for the version being released.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Edson Tirelli <etirelli@redhat.com>
@coderabbitai

coderabbitai Bot commented Nov 12, 2026

Copy link
Copy Markdown

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: b3dfae7e-7aed-4a76-a02c-29aed195ee94

@antowaddle
antowaddle self-requested a review November 12, 2026 15:47

@antowaddle antowaddle left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@etirelli one very small clarification, otherwise all good here.

`stable`, `latest` or a full commit SHA; `$ACT/docs/releasing.md` explains the choices.
Never pin to a branch. Confirm the release contains `provider-coverage-check.yml` and the
Pin the reusable workflows to **`@latest`**, unless the user asks for a version tag,
`stable` or a full commit SHA; `$ACT/docs/releasing.md` explains the choices.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stable doesn't seem to exist as a tag. A caller following the docs gets a workflow-resolution failure — the same class of bug as the @v0.1.0 example this PR fixes. Either create/promote stable now, or mark it as available only after the first promotion and remove it from the copyable alternatives.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That will be created after this merges, closing.

@antowaddle antowaddle left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@etirelli
etirelli merged commit 3bdbe8e into main Nov 12, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants