The README's CI badge reads failing when only non-required jobs fail

Open
#762 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
22/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
github-actions
Domain
ci-cd

Research direction

Read .github/workflows/ci.yml to see which jobs are required and which engine (Firefox/WebKit) journeys currently fail, then check the branch protection settings the badge is compared against and the README badge markup. Note the open dependency on #749 (cancelled push runs) and the upstream Playwright fix (microsoft/playwright#43967), which is why the suggested option is to wait rather than edit the workflow. Done means a maintainer has picked an option and the README badge agrees with main's required-check status.

Written by the indexing model from the issue text.

Description

needs decision priority: low

The CI badge in the README (ci.yml, branch main, event push) reads CI - failing today. The last main run that finished failed only the Firefox and WebKit UI journeys, which aren't required checks: GitHub's workflow badge takes the conclusion of the whole run, every job included. A visitor reads it as main being broken.

Related: #749 (main's push runs are cancelled while queued), which keeps the badge on an old result.

Options

  1. Make the engine journeys required once they pass on main (already planned: the WebKit fixes are in progress, and the Firefox crash is fixed upstream in Playwright's next Firefox, microsoft/playwright#43967). Then the badge and the required checks agree, with no workflow change. Until then the badge stays red.
  2. A badge from the required checks only: a small workflow, run after CI on main, that reports one status from the required jobs' results, and the README points at that workflow's badge. A CI change.
  3. Mark the engine jobs continue-on-error so the run's conclusion ignores them. Hides real engine failures from the run's summary; not recommended.

Suggestion: option 1, since the engines are meant to become required anyway. A maintainer decision: it touches CI and which checks are required.

Dominant language
Rust
Stars
0
Forks
0
Avg merge
56m
Merged PRs (30d)
349

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from nledford/Ladderback

All issues in nledford/Ladderback

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.