Skip to content

Conversation

@mcmire
Copy link
Contributor

@mcmire mcmire commented Oct 24, 2025

Explanation

When we added preview builds to some polyrepos, we copied the workflow from this repo and made some improvements at the same time. This commit applies those same improvements.

  • Add emoji reaction to preview build request comment when workflow begins
  • Simplify preview build docs by removing external contributor-specific instructions
  • Remove package scripts (the scripts used in this workflow aren't meant to be called explicitly)
  • Convert script to generate reply comment to bash
  • Simplify output in reply comment, and fix link to docs

References

(N/A)

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've communicated my changes to consumers by updating changelogs for packages I've changed, highlighting breaking changes as necessary
  • I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

Note

Simplifies preview build publishing and docs: reacts to trigger comment, publishes via workspaces, posts concise identifiers, removes per-package preview scripts, and updates constraints.

  • CI/GitHub Actions (.github/workflows/publish-preview.yml):
    • Add explicit permissions and split flow to react to the trigger comment with a 👍.
    • Use ./scripts/prepare-preview-builds.sh, publish via yarn workspaces ... npm publish --tag preview, and post identifiers via ./scripts/generate-preview-build-message.sh.
    • Standardize GH_TOKEN usage and job dependencies; avoid running on forks.
  • Docs (docs/contributing.md):
    • Rename and simplify preview build instructions; remove fork-specific publishing steps.
    • Add clearer usage examples for Yarn Modern/Classic and NPM; add guidance for updating preview builds.
  • Repo scripts:
    • Add scripts/generate-preview-build-message.sh; remove scripts/generate-preview-build-message.ts.
    • Remove root prepare-preview-builds and publish-previews scripts from package.json.
  • Packages (packages/*/package.json):
    • Remove scripts.publish:preview across packages.
  • Tooling (yarn.config.cjs):
    • Drop constraints enforcing publish:preview script; keep other constraints unchanged.

Written by Cursor Bugbot for commit b5dc52a. This will update automatically on new commits. Configure here.

@mcmire mcmire force-pushed the improve-preview-builds branch from c57838d to f9e45ca Compare October 24, 2025 15:03
@mcmire mcmire changed the title Improve preview builds Improve/simplify preview builds Oct 24, 2025
@mcmire
Copy link
Contributor Author

mcmire commented Oct 24, 2025

Hmm, it seems that the changelog checker workflow is incorrectly requiring changes to changelogs. It needs to omit changes to scripts. I'll make a ticket. I'm adding no-changelog in the meantime.

@mcmire mcmire marked this pull request as ready for review October 24, 2025 15:15
@mcmire mcmire requested review from a team as code owners October 24, 2025 15:16
When we added preview builds to some polyrepos, we copied the workflow
from this repo and made some improvements at the same time. This commit
applies those same improvements.

- Add emoji reaction to preview build request comment when workflow
  begins.
- Simplify preview build docs by removing external contributor-specific
  instructions.
- Remove package scripts from root and workspace packages. The scripts
  used by the preview build workflow aren't meant to be called
  explicitly, and in fact may be dangerous to do so. This also makes the
  workflow more copy-and-pasteable to other projects.
- Convert script to generate reply comment to bash.
- Simplify output in reply comment, and fix link to docs.
cursor[bot]

This comment was marked as outdated.

@mcmire mcmire force-pushed the improve-preview-builds branch from f9e45ca to d8de588 Compare October 24, 2025 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants