Skip to content

ci: docs.yml concurrency comment claims a newer push supersedes an in-flight deploy, but cancel-in-progress: false does the opposite #100

Description

@OmarAlJarrah

Problem

.github/workflows/docs.yml:17-18 has a comment stating: "A newer push to main supersedes an in-flight deploy rather than queueing behind it." The actual config directly below it, cancel-in-progress: false (line 21), means the opposite: the in-progress run is not cancelled, and a newer run in the same pages concurrency group waits until the in-flight run finishes.

cancel-in-progress: false is the standard GitHub Pages template setting, specifically chosen to let a production deploy finish rather than being interrupted midway. Making a newer push actually supersede an in-flight one would require cancel-in-progress: true — the opposite of what's configured.

Impact

Two commits land on main in quick succession. A maintainer trusting the comment expects the first (now-stale) deploy to be cancelled in favor of the second; instead, the first deploy runs to completion and briefly publishes older content before the second deploy starts. The "supersede" behavior the comment describes never actually happens, so anyone debugging a transient stale-docs deploy is misdirected by the comment into looking for the wrong cause.

Suggested fix

Fix the comment to describe the actual (queue-behind, don't-cancel) behavior, or — if superseding is actually the intended behavior — flip cancel-in-progress to true to match the comment.

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

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions