observe: a path that isn't a git checkout is reported as 'worktree CHANGED - report this' (console, job summary, Action PR comment)

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

Maintainers usually reply within 1 day

@FredApps is already working on this.

Since Nov 17, 2026.

  • #283 by @FredApps — open

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
github-actions, node.js, typescript
Domain
ci-cd, testing-qa

Research direction

Start with the three warning displays named in the issue: packages/diffci-cli/src/client/cli.ts, packages/diffci-cli/src/client/job-summary.ts, and action/impact.mjs; then read observe() in packages/diffci-cli/src/client/observe.ts to understand the evidence fields. Check how each display distinguishes an actual difference from missing evidence, and run the relevant tests for those outputs. Done means missing evidence produces no changed-worktree warning, while real differences and disappearing evidence still do.

Written by the indexing model from the issue text.

Description

What went wrong?

If the observed path is not a git checkout, the observation refuses, which is correct. But the console line, the job summary and the Action's pull request comment all say the working tree changed while DiffCI observed it, and ask the user to file a DiffCI bug. DiffCI changed nothing. There was simply no checkout to compare before and after.

This is easy to hit with the Action. Any job that checks out into a subdirectory (actions/checkout with path:, as examples/github-actions-check-plan.yml does) and keeps the default repository-path: ${{ github.workspace }} gets the false alarm.

DiffCI version

CLI 0.3.54 (the Action's pinned default); core main 40aa308

Repro
mkdir -p ws/target && cd ws/target && git init -q && git commit -q --allow-empty -m a && git commit -q --allow-empty -m b && cd ..
echo '{"pull_request":{"number":1,"base":{"sha":"x"},"head":{"sha":"y"}}}' > ../event.json
GITHUB_ACTIONS=true GITHUB_EVENT_NAME=pull_request GITHUB_EVENT_PATH=$PWD/../event.json GITHUB_STEP_SUMMARY=$PWD/../summary.md \
  npx -y -p @diffci.com/[email protected] diffci observe --repo "$PWD" --no-send --out /tmp/r.json
Actual
  status: REFUSED
  non-interference: worktree CHANGED - report this, report written outside the checkout

The job summary has the same message:

> [!WARNING]
> The working tree changed while DiffCI observed it. Please report this at https://github.com/DiffCI/core/issues.

action/impact.mjs's formatComment puts the same warning in the PR comment when comment: "true". The report itself is accurate: nonInterference is {"worktreeUnchanged": false} with no headSha* or worktreeDigest* evidence at all.

Cause

observe() sets worktreeUnchanged to false whenever it cannot read HEAD or the tree (packages/diffci-cli/src/client/observe.ts:183-187). That is the right value for "not proven unchanged". But all three places that display it read false as "changed":

  • packages/diffci-cli/src/client/cli.ts:899
  • packages/diffci-cli/src/client/job-summary.ts:73
  • action/impact.mjs:115
Expected

When nothing could be read before or after (none of the four evidence fields is present), DiffCI has nothing to compare and makes no claim. The refusal reason is enough, and there is no "report this" warning. A real before/after difference, or evidence that disappears, still raises the warning. Narrowing does not change: a refused or unproven observation still never narrows.

Dominant language
TypeScript
Stars
0
Forks
4
Avg merge
18h 41m
Merged PRs (30d)
48

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

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 DiffCI/core

All issues in DiffCI/core

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.