Skip to content

Action Pinning Rule Requires a v-Prefixed Comment That Hub Release Tags Cannot Carry #1805

Description

@ptr727

Finding

GOVERNANCE.md "Workflow YAML Conventions", Action pinning bullet, requires every pinned uses: to carry "a trailing # vX.Y.Z comment". In 624c324 that bullet now also covers cross-repository reusable workflows, since only ./ and $/ references are exempt. The hub's own release tags have no v prefix (2.0.672, 2.0.670), so a pin to a hub task can only carry the bare tag. A constructed example:

uses: ptr727/ProjectTemplate/.github/workflows/validate-task.yml@0123456789abcdef0123456789abcdef01234567 # 2.0.672

Read literally, the rule flags that line. Changing it to # v2.0.672 would name a tag that does not exist, and Dependabot could then no longer match the comment to the tag. Every fleet repository calling a hub task by pin carries this shape. WORKFLOW.md D9.1 says only "a version comment", so the two canonical statements also disagree.

Suggested fix

State the comment as the referenced ref's release tag, for example # vX.Y.Z for an upstream action and the bare release tag for a hub task, rather than prescribing the v form.

Found by a local strict review while resyncing ptr727/aiopurpleair to 624c324, where the repository's own WORKFLOW.md now documents both forms.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions