Skip to content

Commit 39538f1

Browse files
committed
Move package metadata update step to dedicated section of release docs
Previously the instructions for updating the npm package metadata, submitting a PR for that, and merging the PR was in the same section as the tag push instructions in the release procedure documentation. These two operations are distinct from each other. Mashing them into a single step makes the release procedure document difficult to read and the process more prone to error. For this reason, a dedicated step is used for each of the two things.
1 parent 9ef04bb commit 39538f1

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/internal/release-procedure.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ It will be shown in these search results:
1010

1111
https://github.com/arduino/arduino-ide/pulls/app%2Fgithub-actions
1212

13-
## Create the release on GitHub
13+
## Update metadata of packages
1414

15-
First of all, you need to **set the new version in all the `package.json` files** across the app (`./package.json`, `./arduino-ide-extension/package.json`, and `./electron-app/package.json`), create a PR, and merge it on the `main` branch.
15+
You need to **set the new version in all the `package.json` files** across the app (`./package.json`, `./arduino-ide-extension/package.json`, and `./electron-app/package.json`), create a PR, and merge it on the `main` branch.
1616

1717
To do so, you can make use of the `update:version` script.
1818

@@ -29,6 +29,8 @@ git push origin version-<YOUR_VERSION>
2929

3030
replacing `<YOUR_VERSION>` with the version you want to release. Then create a PR and merge it.
3131

32+
## 🚢 Create the release on GitHub
33+
3234
Then, you need to **create and push the new tag** and wait for the release to appear on [the "**Releases**" page](https://github.com/arduino/arduino-ide/releases).
3335

3436
⚠ Doing this will create a new release and users who already have the IDE installed will be notified from the automatic updater that a new version is available. Do not push the tag if you don't want that.

0 commit comments

Comments
 (0)