WordPress / WordPress/contributor-toolkit

`updateIncomplete` does not travel with carried work either, leaving a false banner on trunk

Open
#475 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
JavaScript
Stars
36
Forks
13
Avg merge
23h 19m
Merged PRs (30d)
72

Description

The gap

updateIncomplete is the same shape of bug #236 was, in the same handler, and it is still there.

The work-meta documentation in src/main.js names appliedPatch and updateIncomplete as describing the work rather than the site. A trunk update run from trunk writes updateIncomplete: true at site level. If the contributor then edits something, links a ticket and chooses to take the loose work along, the rebuild finishes on the branch and sites:mark-update-complete clears the branch's copy only.

Trunk is left with a true updateIncomplete and no path to clearing it: a permanent, false "Update incomplete" banner, on a site where the update did complete. Exactly #236's failure, one field over.

Found by the review pass on #473, which fixed the appliedPatch half and deliberately did not touch this one.

The part that needs deciding

Whether the flag should travel at all is a judgement call, and that is the substance here rather than the plumbing.

appliedPatch describes a diff sitting in the worktree, so it belongs wherever those files go. updateIncomplete describes the state of one shared node_modules and build/, which the branches of a site all share. A flag about a build is arguably a property of the site and not of the work, in which case the fix is the opposite one: stop writing it per branch, and clear it at site level wherever the rebuild finishes.

Both readings end the false banner. They differ in what happens when two tickets are worked in turn with a rebuild half done, so it is worth answering before writing anything.

Related

  • #236 — the same bug in the other field
  • #473 — the fix that named this one
  • #446 — the earlier false "Update incomplete", from a different cause

Contributor guide

Open the contributing guide

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.

Research direction

Start in src/main.js and read the work-meta documentation alongside the handling described in #236 and the appliedPatch fix in #473. Decide whether updateIncomplete belongs to carried work or to the shared site state, then define the behavior for sequential tickets and incomplete rebuilds. Done means the chosen model prevents a false persistent “Update incomplete” banner.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
desktop
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.