Skip to content

Publish extension-mermaid with the 2.2.0 family release and draft the launch posts #531

Closed

Description

@HMarzban

Part of #521. Depends on #530. Read the tracker first: its §Shared contract binds this issue. Work on main.

Summary

Release the sixth package with the family at 2.2.0, then prepare the launch that promotes Pele and credits its author (ruling 9).

Rulings: 8, 9, 12 (#521 §Maintainer rulings). The pad feature runs in production from workspace:* source before this release.

Current behaviour

Files and interfaces

Files

  • Modify: README.md, extensions/README.md, context7.json (remove the "not on npm yet" sentences); the root CHANGELOG.md (the family count); extensions/extension-mermaid/CHANGELOG.md (the ## [2.2.0] entry).
  • The release-product skill changes the other release files (versions, the other CHANGELOGs, the release note, the banner, docs/DEMO.md).
  • Create, gitignored: REPO/Notes/local-docs/<date>-mermaid-launch-drafts.md.

Interfaces

Implementation steps

The maintainer runs every publish, push, tag and post. An agent prepares files and checks, and stops at the Review checkpoint.

  • Step 1: Check Pele since the pin. Run curl -s https://registry.npmjs.org/pele | jq -r '.["dist-tags"].latest'.
    • If it is still 1.6.0, record that and go on.
    • If it is a newer 1.6.x, raise the root overrides entry to it, run bun install and bun run test in PKG, and check that bun.lock holds one pele version. Then rerun Run the Mermaid quality pass and ship gates #530 Steps 5-7 (including check:ci and make build-prod-ci), because bun.lock changed after its verdict.
    • If it is 1.7.0 or later, read each newer release on https://github.com/obsidianmd/pele/releases. Then rerun the d.ts greps ([Tracking] Mermaid diagrams in docs.plus through a headless Pele extension #521 §Global constraints → Pele) and bun run test in PKG.
    • Expected: the latest is 1.6.x, or each newer release lists no breaking change and both checks pass.
  • Step 2: Prepare the release text.
    • Remove the sentence "extension-mermaid is not on npm yet; it publishes with the next family release." from README.md, extensions/README.md and context7.json. Check: git -C REPO grep -n "not on npm yet" -- README.md extensions/README.md context7.json prints nothing.
    • In the root CHANGELOG.md, change "The five @docs.plus/extension-* packages keep their own CHANGELOG.md files" to "The six".
    • In extensions/extension-mermaid/CHANGELOG.md, replace ## [Unreleased] with a hand-written ## [2.2.0] and a ### Highlights section (RELEASE_POLICY.md §CHANGELOG style guide). Never generate it from commit subjects.
  • Step 3: The maintainer runs the release. Use the release-product skill (.cursor/skills/release-product/SKILL.md), with the extensions publishing at 2.2.0.
    • Keep the hand-written mermaid ## [2.2.0] entry from Step 2; do not let the skill replace it.
    • The skill's draft pass adds a live diagram section to docs/DEMO.md.
    • Its readiness step runs bun run release:family --dry-run. The other five packages are intended no-ops unless they gain source changes first, so override the skill twice: run the dry run as bun run release:family --dry-run --allow-noop, and in its Ship step 4 run bun run release:family --allow-noop. A preflight failure that names exactly those five siblings, without the flag, is expected. Before the commit, only the clean-tree and npm-login checks may fail.
    • Then follow the skill's §Ship steps. bun publish runs per package through the Chrome passkey, and release:family only tags.
    • Check: curl -s https://registry.npmjs.org/@docs.plus%2fextension-mermaid | jq -r '.["dist-tags"].latest' prints 2.2.0.
  • Step 4: Draft the launch posts. Write REPO/Notes/local-docs/<date>-mermaid-launch-drafts.md. Its first line after the H1 reads: "Drafts only. The maintainer posts after the 2.2.0 npm publish."
    • Rules for every post: lead with the link; one number per post; code only as an image; upload media, never hotlink it. Fetch https://pele.run with WebFetch, and keep each Pele number only beside its source sentence. Our own number is the starter row p95, with its method. Use the credit line from [Tracking] Mermaid diagrams in docs.plus through a headless Pele extension #521 §Pele promotion verbatim.
    • X thread: 3 to 5 posts, each 280 characters or fewer (check each with wc -m). Post 1 leads with the npm link. It quote-posts kepano's Pele launch post, https://x.com/kepano/status/2111472054293913749, and tags @kepano and @obsdmd. Attach the hero GIF (extensions/extension-mermaid/assets/demo-light.gif) and a preview PNG.
    • "Pele in use" request: a draft issue for https://github.com/obsidianmd/pele. It says what docs.plus is, links the package, describes the pad use, and carries the credit line. The channel is unconfirmed: pele.run shows no way to ask for a listing.
    • Tiptap GitHub Discussions post, in the "Community Extensions" category. The form has these fields:
      • Title: Community Extension: @docs.plus/extension-mermaid.
      • Type: Extension.
      • Description: a short paragraph on what it does and why Pele.
      • Installation: npm install @docs.plus/extension-mermaid first, then one line naming pnpm, yarn and bun, and pele as the one runtime dependency.
      • Usage: the README Quickstart block, byte for byte.
      • Other: links to npm, the source and https://docs.plus.
    • awesome-tiptap pull request for https://github.com/ueberdosis/awesome-tiptap: a title, a body, and one line under "Community extensions": * [@docs.plus/extension-mermaid](https://github.com/docs-plus/docs.plus/tree/main/extensions/extension-mermaid) by [@docs-plus](https://github.com/docs-plus). Check the list order when the pull request opens.
    • Check: grep -n -i "creator of obsidian\|endorse\|raw.githubusercontent" <the drafts file> prints nothing.
  • Step 5: Review checkpoint. Report the Step 1 result, the Step 2 checks, the npm version from Step 3, and the drafts file path. Stop. The maintainer posts the drafts.

Acceptance criteria

  • @docs.plus/extension-mermaid@2.2.0 is on npm, and release:family created the six tags.
  • The launch drafts exist and pass the Step 4 check.
  • Context7 is refreshed.

Activity

  1. HMarzban commented on Oct 21, 2026

    @HMarzban
    CollaboratorAuthor

    Step 1 done: Pele is now 1.7.0, 2026-10-20

    npm showed pele@1.7.0 (published 2026-10-19 18:21 UTC), so the pin moved from 1.6.0 in aebd55866. It is deployed in 3784c2c65 (build): front back.

    • Release notes read. 1.7.0 adds mermaidType to render(), parse() and PeleError, and wraps Chinese and Japanese labels between characters. No breaking change.
    • Pins: the root overrides, the package dependencies and apps/hocuspocus.server all say 1.7.0. bun.lock holds one pele@1.7.0.
    • d.ts greps ([Tracking] Mermaid diagrams in docs.plus through a headless Pele extension #521 §Global constraints): 0 and 0 for the Pele names, and insertMermaid 1 and 1.
    • Package tests: bun test src 13/13, typecheck clean, clean-room Cypress 117/117.
    • Server: the MCP checkDiagrams smoke test parses all 14 named types and keeps the same refusals.
    • Cold install: 1741 packages, no integrity error.
    • CI: the deploy run had all six extension suites green, plus Backend E2E.

    lazy.d.ts, the exports map and the maxEdges code are the same as in 1.6.0. The #529 matrix and the #522 laptop measure ran on 1.6.0. So the #522 phone run measures the version that ships.

  2. HMarzban commented on Oct 22, 2026

    @HMarzban
    CollaboratorAuthor

    Shipped in docs.plus 2.2.0.

    • @docs.plus/extension-mermaid@2.2.0 is on npm, as its first publish, together with the other five family packages at 2.2.0.
    • The package tag @docs.plus/extension-mermaid@2.2.0 points at the release commit b71a84d, the same commit as v2.2.0.
    • The launch posts are drafted. They credit Pele and Steph Ango (@kepano).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions