Skip to content

Make the Callgrind performance check report on every pull request - #69

Merged
chrislaupama merged 1 commit into
mainfrom
required-perf-check
Nov 14, 2026
Merged

chrislaupama merged 1 commit into
mainfrom
required-perf-check

Conversation

@chrislaupama

Copy link
Copy Markdown
Collaborator

For #35. The decision is to require lint and Instructions (Linux, Callgrind) on main, in addition to the three build-test checks. RustSec, Dependency review and the timing jobs stay advisory.

Why a workflow change first

The Performance workflow used a paths filter on pull_request, so it never started on a PR that doesn't touch the benchmarked code. A required check that never reports would block those PRs forever.

What changes

  • Every PR starts the workflow. pull_request no longer has a path filter. Pushes to main keep theirs.
  • New changes job. It diffs the PR against its base. If nothing under engine/, crates/dstudio-core/, Cargo.lock, tools/perf/ or perf.yml changed, it outputs perf=false.
  • Instructions and Time jobs skip when there's nothing to compare. Both needs: changes and are skipped on perf=false, and GitHub counts a skipped job as passed for required checks. If changes itself fails, its output is empty and the comparison still runs, so a failure there can't open a bypass.
  • Docs. docs/building.md lists the new required checks and explains the skip.

After this merges, branch protection on main gets lint and Instructions (Linux, Callgrind) as required checks.

Verification

  • On this PR, which only changes perf.yml and docs, the workflow runs the full comparison, because perf.yml itself is a benchmarked path.
  • A docs-only PR afterwards should show Instructions (Linux, Callgrind) as skipped and passing.

There are no screenshots because nothing visual changes. There are no benchmarks for the same reason: nothing in the app or engine is touched.


Generated by Claude Code

The Performance workflow only started on pull requests that touched the
benchmarked paths, so its Instructions check could not be required on main:
every other pull request would wait for it forever. Pull requests now always
start the workflow, and a small changes job skips both comparisons when
nothing the benchmarks build changed (a skipped job counts as passed). If
that job fails the comparison runs anyway. Pushes to main keep their path
filter.

The build docs now list lint and Instructions (Linux, Callgrind) as required
checks next to the three build-test ones.

For #35
@chrislaupama
chrislaupama marked this pull request as ready for review November 14, 2026 21:49
@chrislaupama
chrislaupama merged commit 0c78452 into main Nov 14, 2026
17 checks passed
@chrislaupama
chrislaupama deleted the required-perf-check branch November 14, 2026 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant