jeans/arduino-ide
jeans/arduino-ide
1
0
Fork 0
mirror of https://github.com/arduino/arduino-ide.git synced 2025-04-19 12:57:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move package metadata update step to dedicated section of release docs

Browse Source 
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.
This commit is contained in:
per1234 2022-09-24 16:36:18 -07:00
parent 9ef04bb8d6
commit 39538f163f
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/internal/release-procedure.md
View File

@ -10,9 +10,9 @@ It will be shown in these search results:
https://github.com/arduino/arduino-ide/pulls/app%2Fgithub-actions
## ⚙ Create the release on GitHub
## ⚙ Update metadata of packages
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.
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.
To do so, you can make use of the `update:version` script.
@ -29,6 +29,8 @@ git push origin version-<YOUR_VERSION>
replacing `<YOUR_VERSION>` with the version you want to release. Then create a PR and merge it.
## 🚢 Create the release on GitHub
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).
⚠ 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.