Skip to content

fix(release): regenerate the module README table when the interface bumps - #195

Merged
Upd4ting merged 1 commit into
mainfrom
fix/interface-release-sync-readme
Nov 12, 2026
Merged

Upd4ting merged 1 commit into
mainfrom
fix/interface-release-sync-readme

Conversation

@Upd4ting

Copy link
Copy Markdown
Member

Summary

antelopejs-sync writes the dependency table in packages/dms-builder/README.md, and its "Tested with" column reads the workspace interface version. The interface release bumps packages/interface-dms-builder/package.json, but its after:bump hook staged only CHANGELOG.md. So the release commit left the README stale and failed sync:check. Same bug as AntelopeJS/dms#855. The hook now matches dms-saas and dms-media:

 "hooks": {
-  "after:bump": "git add CHANGELOG.md"
+  "after:bump": ["pnpm --dir ../.. run sync", "git add -u ../..", "git add CHANGELOG.md"]
 }
flowchart LR
  A[release-it bumps interface package.json] --> B[after:bump: pnpm run sync]
  B --> C[README table shows the new version]
  C --> D[git add -u ../.. and CHANGELOG.md]
  D --> E[release commit passes sync:check]
Loading

Evidence

  • Before: the release commit 09b1e98 (chore(release): @antelopejs/interface-dms-builder v0.4.1) failed ci. Reproduced locally on that commit:

    [sync:check]
    > antelopejs-sync --check
    Drift: packages/dms-builder/README.md; run antelopejs-sync
    Checks: 7 passed, 1 failed.
    

    Running antelopejs-sync there shows the drift:

    -| `@antelopejs/interface-dms-builder`      | `>=0.4.0 <0.5.0`  | `0.4.0`     |
    +| `@antelopejs/interface-dms-builder`      | `>=0.4.0 <0.5.0`  | `0.4.1`     |
    
  • After: I ran the real pnpm release in a scratch worktree at 44379bc (the commit before the 0.4.1 release), with this config committed on top. I passed the shared workflow's arguments (--ci --git.requireBranch=<branch> --git.tagExclude=*.*.*-* --plugins.release-it-changelogen.from=interface-v0.4.0) plus --git.requireUpstream=false --git.tag=false --git.push=false --github.release=false --npm.publish=false, so it made only a local commit:

    🚀 Let's release @antelopejs/interface-dms-builder (0.4.0...0.4.1)
    ✔ npm version
    ✔ pnpm --dir ../.. run sync
    ✔ git add -u ../..
    ✔ git add CHANGELOG.md
    ✔ Git commit
    🏁 Done (in 2s.)
    
     packages/dms-builder/README.md              |  2 +-
     packages/interface-dms-builder/CHANGELOG.md | 57 +++++++++++++++++++++++++++++
     packages/interface-dms-builder/package.json |  2 +-
    

    pnpm run checks on that release commit:

    Checks: 8 passed, 0 failed.
    

    pnpm run checks on this branch: Checks: 12 passed, 0 failed.

Merge Danger

Door: two-way. Only the interface release hook changes.

Blast Radius: release-only. It affects the next interface release commit, which will also carry any other tracked file that antelopejs-sync rewrites.

@Upd4ting
Upd4ting merged commit 6918b01 into main Nov 12, 2026
24 of 27 checks passed
@Upd4ting
Upd4ting deleted the fix/interface-release-sync-readme branch November 12, 2026 05:32
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