Skip to content

chore: add pkg-pr-new workflow for automated publishing - #937

Merged
hugomrdias merged 2 commits into
masterfrom
hugomrdias/pkg-pr
Aug 25, 2026
Merged

chore: add pkg-pr-new workflow for automated publishing#937
hugomrdias merged 2 commits into
masterfrom
hugomrdias/pkg-pr

Conversation

@hugomrdias

@hugomrdias hugomrdias commented Aug 25, 2026

Copy link
Copy Markdown
Member

Summary

  • Publish preview builds of @filoz/synapse-sdk, @filoz/synapse-core, and @filoz/synapse-react on every push and pull request via pkg.pr.new, so unreleased changes can be installed without waiting for npm.
  • The workflow builds the workspace, then runs pnpm exec pkg-pr-new publish --pnpm './packages/*'. The pkg.pr.new bot comments on PRs with install commands.
  • Document the setup and install URLs in Developer Guides, covering PRs (@123), commits (@a832a55), and master (@master).

Example:

npm i https://pkg.pr.new/@filoz/synapse-sdk@937
npm i https://pkg.pr.new/@filoz/synapse-sdk@master
npm i https://pkg.pr.new/@filoz/synapse-sdk@a832a55

Test plan

  • Confirm the pkg.pr.new bot commented install URLs on this PR
  • Install a preview package from the PR number, a commit SHA, and (after merge) @master
  • Check the Preview Packages page renders under Developer Guides and that Getting Started / Core / React links resolve

@hugomrdias
hugomrdias requested a review from rvagg as a code owner August 25, 2026 14:12
@github-project-automation github-project-automation Bot moved this to 📌 Triage in FOC Aug 25, 2026
@socket-security

socket-security Bot commented Aug 25, 2026

Copy link
Copy Markdown

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Addednpm/​pkg-pr-new@​0.0.881001007097100

View full report

@hugomrdias hugomrdias linked an issue Aug 25, 2026 that may be closed by this pull request
@hugomrdias hugomrdias self-assigned this Aug 25, 2026
@hugomrdias hugomrdias added this to the 202608 Contract Release milestone Aug 25, 2026
@pkg-pr-new

pkg-pr-new Bot commented Aug 25, 2026

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/@filoz/synapse-core@937
npm i https://pkg.pr.new/@filoz/synapse-react@937
npm i https://pkg.pr.new/@filoz/synapse-sdk@937

commit: 47c1d32

Explain pkg.pr.new setup and the install URLs for PRs, commits, and master so users can try packages before a release.
@hugomrdias
hugomrdias requested review from a team, BigLep, jennijuju and rjan90 as code owners August 25, 2026 14:29
@hugomrdias
hugomrdias removed request for a team, jennijuju and rjan90 August 25, 2026 14:30
@BigLep BigLep moved this from 📌 Triage to 🔎 Awaiting review in FOC Aug 25, 2026
@BigLep
BigLep requested a lite review from Copilot August 25, 2026 14:33

@SgtPooki SgtPooki left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm. makes me want a focified version honestly..

@github-project-automation github-project-automation Bot moved this from 🔎 Awaiting review to ✔️ Approved by reviewer in FOC Aug 25, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds automated preview-package publishing via pkg.pr.new so contributors can install unreleased builds of Synapse packages directly from PRs/commits/master, and documents how to use these previews across the docs site.

Changes:

  • Add pkg-pr-new as a dev dependency for running the publish CLI in CI.
  • Introduce a new GitHub Actions workflow to build and publish previews on push and pull_request.
  • Add documentation and links/redirects for “Preview Packages” across Getting Started and Developer Guides.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
package.json Adds pkg-pr-new CLI dependency used by the new publishing workflow.
.github/workflows/pkg-pr-new.yml New workflow to build the workspace and publish preview packages via pkg.pr.new.
docs/src/content/docs/developer-guides/preview-packages.mdx New guide explaining preview package setup and install URL formats.
docs/src/content/docs/getting-started/index.mdx Adds a tip and guide link pointing readers to Preview Packages.
docs/src/content/docs/developer-guides/synapse-react.mdx Adds a tip linking to Preview Packages for unreleased React builds.
docs/src/content/docs/developer-guides/synapse-core.mdx Adds a tip linking to Preview Packages for unreleased Core builds.
docs/astro.config.mjs Adds a redirect to the new Preview Packages doc route.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread package.json
Comment on lines 26 to 31
"@biomejs/biome": "catalog:",
"knip": "6.32.2",
"markdownlint-cli2": "0.23.2",
"pkg-pr-new": "^0.0.88",
"typescript": "catalog:",
"wireit": "0.14.13"
@hugomrdias
hugomrdias merged commit f41a476 into master Aug 25, 2026
19 checks passed
@hugomrdias
hugomrdias deleted the hugomrdias/pkg-pr branch August 25, 2026 14:48
@github-project-automation github-project-automation Bot moved this from ✔️ Approved by reviewer to 🎉 Done in FOC Aug 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 🎉 Done

Development

Successfully merging this pull request may close these issues.

Support stable install URL for pre-release/RC builds

5 participants