chore: open-source release prep#24
Conversation
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
| publish: | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 10 | ||
| steps: | ||
| - uses: actions/checkout@v5 | ||
|
|
||
| - uses: actions/setup-node@v5 | ||
| with: | ||
| node-version: 20 | ||
| cache: npm | ||
| registry-url: "https://registry.npmjs.org" | ||
|
|
||
| - run: npm ci | ||
|
|
||
| - name: Verify tag matches package version | ||
| run: | | ||
| TAG="${GITHUB_REF_NAME}" | ||
| VERSION="v$(node -p "require('./package.json').version")" | ||
| if [ "$TAG" != "$VERSION" ]; then | ||
| echo "Tag $TAG does not match package version $VERSION" | ||
| exit 1 | ||
| fi | ||
|
|
||
| - run: npm run typecheck | ||
| - run: npm run test | ||
| - run: npm run build | ||
| - run: npx size-limit | ||
| - run: npm run check:gpu-leak | ||
| - run: npm run check:pack | ||
|
|
||
| - run: npm publish --provenance --access public | ||
| env: | ||
| NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} |
There was a problem hiding this comment.
🚩 Release workflow runs fewer checks than CI — no React 19 or Node 24 coverage
The CI workflow (.github/workflows/ci.yml) matrices across React 18/19 and Node 20/24 (4 combinations), but the release workflow (.github/workflows/release.yml:14-45) runs only Node 20 with the default React 18. This means a tag push could publish a package that hasn't been validated against React 19 in the release pipeline itself. In practice, the tag commit will usually have passed CI first (since CI runs on pushes to main), but there's no enforcement that CI was green before the tag was pushed — someone could push a tag on a commit that bypassed or failed CI. Consider either adding the React 19 leg to the release workflow, or adding a step that verifies the commit's CI status before publishing.
Was this helpful? React with 👍 or 👎 to provide feedback.
| - run: npm ci | ||
|
|
||
| - run: npm run build:site | ||
| env: | ||
| GITHUB_PAGES: "true" | ||
|
|
||
| - uses: actions/configure-pages@v6 | ||
|
|
||
| - uses: actions/upload-pages-artifact@v5 | ||
| with: | ||
| path: dist-site |
There was a problem hiding this comment.
📝 Info: Pages workflow builds without running tests first
The Pages workflow (.github/workflows/pages.yml:33-43) runs npm ci then npm run build:site and deploys, but does not run tests, typecheck, or any validation before deploying. If a broken commit lands on main (e.g., a force-push or a merge that passes CI but breaks the site build in a way tests don't catch), the Pages deployment proceeds anyway. This is likely acceptable since the site is just the playground/docs and CI already gates PRs, but it's worth noting that the site could deploy from a commit where the library itself is broken.
Was this helpful? React with 👍 or 👎 to provide feedback.
Greptile SummaryThis PR prepares the repository for a public release. The main changes are:
Confidence Score: 5/5Safe to merge with minimal risk. Changes are documentation, repository hygiene, source comments, and CI workflow additions. The workflow changes align with existing package scripts and version metadata. The source changes are comment-only and do not alter runtime behavior. No files require special attention.
 T-Rex LogsWhat T-Rex did
Important Files Changed
Sequence Diagram%%{init: {'theme': 'neutral'}}%%
sequenceDiagram
participant Maintainer
participant GitHub as GitHub Actions
participant Checks as Guard Suite
participant NPM as npm Registry
participant Pages as GitHub Pages
Maintainer->>GitHub: "Push main or v* tag"
alt Push to main
GitHub->>GitHub: Run Pages workflow
GitHub->>Checks: npm ci + npm run build:site
Checks-->>GitHub: dist-site artifact
GitHub->>Pages: Deploy playground docs site
else "Push v* tag"
GitHub->>GitHub: Run Release workflow
GitHub->>Checks: Verify tag matches package.json version
GitHub->>Checks: typecheck, test, build, size, gpu leak, pack
Checks-->>GitHub: Guards pass
GitHub->>NPM: npm publish --provenance --access public
end
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
sequenceDiagram
participant Maintainer
participant GitHub as GitHub Actions
participant Checks as Guard Suite
participant NPM as npm Registry
participant Pages as GitHub Pages
Maintainer->>GitHub: "Push main or v* tag"
alt Push to main
GitHub->>GitHub: Run Pages workflow
GitHub->>Checks: npm ci + npm run build:site
Checks-->>GitHub: dist-site artifact
GitHub->>Pages: Deploy playground docs site
else "Push v* tag"
GitHub->>GitHub: Run Release workflow
GitHub->>Checks: Verify tag matches package.json version
GitHub->>Checks: typecheck, test, build, size, gpu leak, pack
Checks-->>GitHub: Guards pass
GitHub->>NPM: npm publish --provenance --access public
end
Reviews (1): Last reviewed commit: "docs: add release prep handoff notes" | Re-trigger Greptile |
1 participant
Gets the public repo release-ready. No runtime/source behavior changes beyond two comment edits.
Removed internal artifacts
BRIEF.md,docs/superpowers/(plans + specs),prototypes/(7 HTML files) — internal dev process, not for a public library face. Still in git history.src/comments (FlowStagger.tsx,useFlow.ts) that pointed at deleted prototype files, and the README design-spec link.README reconciled with the shipped 0.5.0 surface
(v0.3)heading; fixed the quick-start snippet (referenced an undefinedloadingvar +Thinking/ChatPanelthat weren't imported).Caustics,LiquidCard,MeniscusDivider,LiquidPanel,LiquidTooltip,LiquidText,LiquidDialog,VoiceBall.mercurymaterial; documented thecausticsmaterial.New primitive docs
Concise pages for the 7 previously-undocumented components, matching the existing docs format and real prop types.
OSS scaffolding
CONTRIBUTING.md,SECURITY.md,CODE_OF_CONDUCT.md, bug/feature issue templates, PR template.CI/CD
release.yml— publish-on-tag (v*) with npm provenance, tag↔version guard, full guard suite. NeedsNPM_TOKENsecret.pages.yml— deploys the playground docs site to GitHub Pages (GITHUB_PAGES=true→ vitebase: /fluidkit/, local dev unchanged).Verified locally
typecheck clean · 570/570 tests · build ok · size 31.14 kB / 36.7 kB · gpu-leak ✓ · pack ✓ ·
build:siteemitsdist-site/with/fluidkit/-prefixed assets.Maintainer follow-up (post-merge)
NPM_TOKENrepo secret.v0.5.0tag to trigger the publish workflow.See
RELEASE_PREP_NOTES.md.Summary by cubic
Prepares
fluidkitfor open-source release by removing internal artifacts, adding OSS docs/templates, and setting up tag-based publish and Pages deploy. No runtime changes; only two comment edits.CI/CD
v*with provenance and tag↔package version guard; runs typecheck, tests, build,size-limit, GPU-leak, and pack checks; needsNPM_TOKEN.GITHUB_PAGES=trueand deploysdist-site/;vitebaseswitches to/fluidkit/only in CI.Migration
NPM_TOKENrepo secret.v0.5.0tag to trigger publish.Written for commit 3c83d88. Summary will update on new commits.