Skip to content

release-doc-sync@v1 default meta-repo-ref points at non-existent v1.0 tag, breaks first-time consumers #42

@TMHSDigital

Description

@TMHSDigital

Summary

The release-doc-sync@v1 composite action defaults its meta-repo-ref input to v1.0, but the TMHSDigital/Developer-Tools-Directory repository has no v1.0 git ref (neither tag nor branch). Every consumer that does not override the input fails at the action's internal checkout step with git fetch --depth=1 origin +refs/heads/v1.0*:refs/remotes/origin/v1.0* +refs/tags/v1.0*:refs/tags/v1.0* exit code 1.

Where the default is set

.github/actions/release-doc-sync/action.yml, input meta-repo-ref:

meta-repo-ref:
  description: 'git ref of TMHSDigital/Developer-Tools-Directory to use for the sync script. Defaults to v1.0 (latest 1.x.y).'
  required: false
  default: 'v1.0'

The accompanying header comment on the same file says: "The meta-repo's tag pipeline maintains the v1.0 tag pointing at the latest 1.x.y. See DTD#14 for the floating-tag automation follow-up."

Current state of meta-repo tags

Existing floating-style tags: v1, v1.6, v1.7, v1.8, v1.9. Existing specific tags include v1.9.1 (current). There is no v1 to v1.x chain that includes v1.0. There is also no v1.0 branch.

Reproduction

A consumer release.yml using the default invocation:

- uses: TMHSDigital/Developer-Tools-Directory/.github/actions/release-doc-sync@v1
  with:
    plugin-version: 0.1.0
    previous-version: 0.1.0

Fails with three retries of the fetch and exit code 1 on the action's internal actions/checkout@v5 step targeting ref: v1.0.

Surfaced today during the Blender-Developer-Tools v0.1.0 first release. Workaround in the consumer is to pass meta-repo-ref: v1.9.1 (or any other extant tag) explicitly. Without that override, every consumer using release-doc-sync@v1 for the first time hits this.

Suggested fixes (one or both)

  1. Create the v1.0 floating tag and have the meta-repo's tag-maintenance job keep it pointing at the latest v1.x.y. The action header already documents this contract; the tag just was never created or never moved.
  2. Change the action default from v1.0 to v1 (which already exists as a floating tag) and update the header comment to match. This is the smaller change and removes the dependency on a tag that has not been maintained.

Either fix unblocks all current and future consumers without requiring them to pass meta-repo-ref explicitly.

Related

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