-
Notifications
You must be signed in to change notification settings - Fork 58
docs: update documentation to use pnpm over yarn #1449
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: update documentation to use pnpm over yarn #1449
Conversation
This reverts commit a7cdb0a.
Replace Yarn with PNPM across docs and scripts to migrate amplitude-typescript per AMP-145286Update documentation and package scripts to use 🖇️ Linked IssuesThis PR implements the migration in AMP-145286 under the AMP-145285 epic and contributes to the AMP-91393 initiative by standardizing 📍Where to StartStart with the workflow change in publish-single-package.yml to verify CI behavior, then review documentation updates in README.md. Changes since #1449 opened
Macroscope summarized 8b992d0. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates all documentation references from yarn to pnpm to reflect the project's migration to pnpm as the package manager.
- Updates command examples in documentation files (README, CONTRIBUTING, AGENTS)
- Updates inline comments in package.json scripts to reflect pnpm usage
- Updates HTML test page instructions
- Updates issue template to mention pnpm as an installation method
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| test-server/proxy-test.html | Updates proxy server command from yarn to pnpm |
| test-server/README.md | Updates all development and production commands from yarn to pnpm |
| packages/unified/package.json | Updates autogenerated script comment from yarn to pnpm |
| packages/session-replay-browser/package.json | Updates autogenerated script comment from yarn to pnpm |
| packages/segment-session-replay-plugin/package.json | Updates autogenerated script comment from yarn to pnpm |
| packages/plugin-session-replay-browser/package.json | Updates autogenerated script comment from yarn to pnpm |
| packages/plugin-autocapture-browser/package.json | Updates watch-bundle script to use pnpm |
| README.md | Updates getting started and troubleshooting commands from yarn to pnpm |
| CONTRIBUTING.md | Updates build/test commands and build system reference from yarn to pnpm |
| AGENTS.md | Updates all testing and linting commands from yarn to pnpm |
| .github/ISSUE_TEMPLATE/Bug_report.md | Adds pnpm to installation methods list |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Environment | ||
| - JS SDK Version: <!--- E.g. 7.1.0 --> | ||
| - Installation Method: <!-- I.e. NPM/Yarn or <script> import --> | ||
| - Installation Method: <!-- I.e. NPM/yarn/pnpm or <script> import --> |
Copilot
AI
Dec 29, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The capitalization is inconsistent here. The comment uses lowercase "yarn" but uppercase "NPM". For consistency, consider either capitalizing all package managers (NPM/Yarn/pnpm) or using all lowercase (npm/yarn/pnpm). The common convention is to use lowercase for package manager names when referring to the CLI tools.
| - Installation Method: <!-- I.e. NPM/yarn/pnpm or <script> import --> | |
| - Installation Method: <!-- I.e. npm/yarn/pnpm or <script> import --> |
5052589 to
dbd701a
Compare
9be93db to
0cc1a15
Compare
dbd701a to
4355f5f
Compare
Mercy811
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
…cript into AMP-145286-pnpm-documentation-examples
| - name: Setup PNPM | ||
| uses: pnpm/action-setup@v4 | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed pnpm setup action breaks CI workflow
The pnpm/action-setup@v4 action step was removed, but the workflow still uses pnpm commands (pnpm install, pnpm build, pnpm test, etc.). While actions/setup-node@v4 with cache: "pnpm" handles caching, it does not install pnpm itself. All other workflow files in this repository (ci.yml, ci-nx.yml, docs.yml, e2e.yml) correctly include the pnpm setup step before setup-node. Without this action, the pnpm binary won't be available and the workflow will fail.
253e268
into
pnpm-migration
Summary
(see title)
Checklist
Note
Standardizes tooling to pnpm
yarnwithpnpmacrossREADME.md,CONTRIBUTING.md,AGENTS.md,test-server/README.md, andtest-server/proxy-test.htmlBug_report.mdenvironment section to includepnpmand correct casingpnpminpackage.jsonforplugin-autocapture-browser(watch-bundle) and alignversion-filescripts inplugin-session-replay-browser,segment-session-replay-plugin,session-replay-browser, andunifiedNo runtime code changes
Written by Cursor Bugbot for commit 32b6f23. This will update automatically on new commits. Configure here.