Skip to content

Commit b64dbe7

Browse files
authored
chore: update releasing instructions to mention npm run update-snapshot-tests (#767)
1 parent a0a032a commit b64dbe7

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/releasing.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,12 @@ command and lerna will interactively ask you to input the correct bumps for
5252
each individual package. You may need to do this when first releasing a 0.X
5353
package as 1.0.0.
5454

55-
## Run `npm install && npm run compile`
55+
## Run `npm install && npm run compile && npm run update-snapshot-tests`
5656

57-
Don't forget this step! This will build everything and regenerate the
58-
`src/version.ts` files in each subpackage.
57+
Don't forget this step! This will build everything, and regenerate the `src/version.ts` files
58+
in each subpackage. Updating the version files will actually change the user agent string the
59+
exporters use, so you will need to `update-snapshot-tests` to update snapshot/golden tests with
60+
the new expected user agent. The user agent should be the **only** change to the snapshots.
5961

6062
## Create a new commit
6163

0 commit comments

Comments
 (0)