Skip to content

ci: CONTRIBUTING.md fails oxfmt --check, blocking all PR CI #29039

@dominicnunez

Description

@dominicnunez

Problem

The check CI job fails on every PR because CONTRIBUTING.md doesn't pass oxfmt --check. Since CI runs against the merge commit (PR branch merged into main), the unformatted CONTRIBUTING.md from main is always included and causes the format:check step to fail.

Example from PR #29031:

CONTRIBUTING.md (179ms)

Format issues found in above 1 files. Run without `--check` to fix.
Finished in 2582ms on 5727 files using 20 threads.
ELIFECYCLE  Command failed with exit code 1.

Details

  • oxfmt version: 0.35.0 (same in CI and locally)
  • The file passes oxfmt --check locally on Linux — this may be a platform-specific difference (Ubuntu 24.04 in CI vs other distros locally), or a shallow-clone artifact from the CI checkout
  • The format:check step runs before tsgo, lint, etc., so this blocks all downstream checks from even running

Fix

Run oxfmt --write on CONTRIBUTING.md in the CI environment and commit the result, or investigate why the file formats differently on the CI runner.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions