Skip to content

Commit e12a9ff

Browse files
committed
Revert inappropriate yarn->pnpm changes in develop-docs files that document other repositories
1 parent fef8591 commit e12a9ff

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

develop-docs/backend/api/public.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -378,7 +378,7 @@ e.g. `/Users/yourname/code/sentry/tests/apidocs/openapi-derefed.json`.
378378

379379
In `sentry-docs`:
380380

381-
1. Run `OPENAPI_LOCAL_PATH=<COPIED_FULL_PATH> DISABLE_THUMBNAILS=1 pnpm dev` and substitute
381+
1. Run `OPENAPI_LOCAL_PATH=<COPIED_FULL_PATH> DISABLE_THUMBNAILS=1 yarn dev` and substitute
382382
`<COPIED_FULL_PATH>` with the path to your local openapi-derefed.json.
383383

384384
Unfortunately changes do not automatically reflect in your local server, so you will need to

develop-docs/development-infrastructure/environment/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,12 @@ First we will use [mkcert](https://github.com/FiloSottile/mkcert) to create and
6565
brew install mkcert
6666
brew install nss # if you use Firefox
6767
brew install caddy
68-
pnpm mkcert-localhost
68+
yarn mkcert-localhost
6969
```
7070

7171
Then we will run the reverse proxy as needed:
7272
```shell
73-
pnpm https-proxy
73+
yarn https-proxy
7474
```
7575

7676
After the server is running we can visit the dev server using `https` at port `:8003` instead of over `http` at `:8000`.

develop-docs/frontend/upgrade-policies.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ On the other hand, choosing to constantly keep packages updated to the absolute
3333

3434
- Upgrading can in some cases be a non-trivial effort for marginal gains. Validating even small upgrades takes time, often when really nothing has changed. (This is of course a slippery slope, wait too long and packages can become exponentially more work to upgrade)
3535

36-
- There is a cost to too much `package.json` churn such as developers having to constantly run `pnpm install` on every git pull.
36+
- There is a cost to too much `package.json` churn such as developers having to constantly run `yarn install` on every git pull.
3737

3838
- A security vulnerability may be introduced in a new version that was not previously present. If we had waited to upgrade until the patch we would not be vulnerable.
3939

@@ -52,13 +52,13 @@ You may not have to do this manually! See the below section on [Take advantage o
5252
### Seeing what can be upgraded
5353

5454
```bash
55-
pnpm outdated --color | sort
55+
yarn outdated --color | sort
5656
```
5757

5858
### Upgrading packages
5959

6060
```bash
61-
pnpm upgrade --latest [package-name] [...]
61+
yarn upgrade --latest [package-name] [...]
6262
```
6363

6464
<Alert>
@@ -70,7 +70,7 @@ Don't forget to upgrade the `@types/[package-name]` package as well if necessary
7070
If you would like to upgrade a group of packages (for example `@babel`) you can use
7171

7272
```bash
73-
pnpm upgrade --latest $(pnpm outdated | cut -d' ' -f1 | grep [group-name])
73+
yarn upgrade --latest $(yarn outdated | cut -d' ' -f1 | grep [group-name])
7474
```
7575

7676
## Proper testing of upgrades
@@ -149,21 +149,21 @@ For example, some dependencies such as `webpack` fall both into the app build **
149149

150150
- Does `sentry devserver` still correctly run the client-side application?
151151

152-
- Does `pnpm dev-ui` still run the client-only version of the application?
152+
- Does `yarn dev-ui` still run the client-only version of the application?
153153

154154
Depending on what package you're upgrading, you'll what to consider what to test. For example, if you upgraded `fork-ts-checker-webpack-plugin` you'll want to validate that types are still being checked in development.
155155

156156
5. **Upgrade the package in getsentry if applicable**
157157

158158
Developer tooling and build packages are currently duplicated in `getsentry`'s `package.json`. For those packages, it is important to remember that you will need to upgrade the package in both places.
159159

160-
6. **Read the `pnpm-lock.yaml` diff**
160+
6. **Read the `yarn.lock` diff**
161161

162162
It's good to understand exactly what has changed with the upgrade. It's generally a bad thing if upgrading has caused a discrepancy in shared sub dependency versions. For example, if you upgrade `lodash` but another top level package specifies that it needs and older version of `lodash` we will now have **two versions** of `lodash` installed. That means two separate versions of `lodash` will be shipped!
163163

164-
Generally you will want to make sure nothing has duplicated versions, in that case you may need to use `[pnpm-dedupe](https://www.npmjs.com/package/pnpm-dedupe)` or in the worst case you may need to upgrade the package which is pulling in the offending older versions.
164+
Generally you will want to make sure nothing has duplicated versions, in that case you may need to use `[yarn-deduplicate](https://www.npmjs.com/package/yarn-deduplicate)` or in the worst case you may need to upgrade the package which is pulling in the offending older versions.
165165

166-
See [The Ultimate Guide to pnpm lockfiles](https://pnpm.io/pnpm-lock.html) for an in-depth look on how these work.
166+
See [The Ultimate Guide to yarn.lock Lockfiles](https://www.arahansen.com/the-ultimate-guide-to-yarn-lock-lockfiles/) for an in-depth look on how these work.
167167

168168
7. **Validate in production after the upgrade is merged**
169169

develop-docs/services/chartcuterie.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ chart-rendering.enabled: true
108108
Currently you need to manually build the configuration module in your development environment.
109109
110110
```shell
111-
pnpm build-chartcuterie-config
111+
yarn build-chartcuterie-config
112112
```
113113

114114
You can then boot the Chartcuterie devservice. If the devservice doesn't start
@@ -141,7 +141,7 @@ Chartcuterie.
141141

142142
### Updating chart types locally
143143

144-
Currently you need to rebuild the configuration module using `pnpm
144+
Currently you need to rebuild the configuration module using `yarn
145145
build-chartcuterie-config` on every change. This may be improved in the future.
146146

147147
## How it works

0 commit comments

Comments
 (0)