Skip to content

ci: test.yml's header comment claims it runs on every push, but pushes outside main are only covered via pull_request #39

Description

@dmccoystephenson

Problem

The header comment of .github/workflows/test.yml reads:

# Runs the test suite on every push and pull request so regressions are
# caught before merge, rather than relying solely on manual local validation.

The triggers immediately below it are narrower:

on:
  push:
    branches: [main]
  pull_request:

A push to a feature branch is therefore only covered once a pull request has been opened for it. A branch pushed without one runs nothing, and the silence is indistinguishable from a green run.

The identical wording had also drifted into README.md, where it was corrected in PR #38. The workflow comment was deliberately left untouched there, because workflow files are excluded from autonomous change — this issue exists so the two do not stay out of step.

Suggested fix

Reword the comment to match the triggers, for example:

# Runs the test suite on every pull request and on every push to main, so
# regressions are caught before merge rather than relying solely on manual
# local validation. A branch pushed without an open pull request is not
# covered.

Broadening the trigger to all pushes is the alternative, at the cost of running the 3.9-3.13 matrix twice for every commit on a branch that already has a pull request open. Which of the two is wanted is a maintainer call; only the comment is wrong today.

This issue was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).


drafted by Claude on behalf of Daniel Stephenson

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

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions