Skip to content

Commit d398ed1

Browse files
committed
Add bundled tools version check step to release procedure
The Arduino IDE release includes several tool dependencies. Unstable versions of these tools may be pinned provisionally for use with the development version of Arduino IDE, but production releases of Arduino IDE must use production releases of the tool dependencies. The release manager should check the tool versions before making a release, but previously this step was not mentioned in the release procedure documentation.
1 parent fb10de1 commit d398ed1

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

docs/internal/release-procedure.md

+14-6
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,15 @@ It will be shown in these search results:
1414

1515
https://github.com/arduino/arduino-ide/pulls/app%2Fgithub-actions
1616

17-
### 2. 👀 Check version of packages
17+
### 2. 🛠️ Check bundled tool versions
18+
19+
The Arduino IDE release includes several tool dependencies. Unstable versions of these tools may be pinned provisionally for use with the development version of Arduino IDE, but production releases of Arduino IDE must use production releases of the tool dependencies.
20+
21+
The tool versions are defined in the `arduino` object of [`arduino-ide-extension/package.json`](../../arduino-ide-extension/package.json).
22+
23+
If any of the tools are pinned to a development version, ensure a suitable production release of the tool is available and then submit a PR to update the version in `arduino-ide-extension/package.json`.
24+
25+
### 3. 👀 Check version of packages
1826

1927
The [`version` field](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#version) of the project's `package.json` metadata files received a patch version bump (e.g., `2.0.1` -> `2.0.2`) at the time of the previous release.
2028

@@ -31,7 +39,7 @@ If the version number of the previous release was `2.0.1`:
3139
- If this is considered a minor release (non-breaking changes to the "API"), the `version` values must be changed to `2.1.0`.
3240
- If this is considered a major release (breaking changes to the "API"), the `version` values must be changed to `3.0.0`.
3341

34-
### 3. 🚢 Create the release on GitHub
42+
### 4. 🚢 Create the release on GitHub
3543

3644
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).
3745

@@ -46,13 +54,13 @@ git push origin <YOUR_VERSION>
4654

4755
Pushing a tag will trigger a **GitHub Actions** workflow on the `main` branch. Check the "**Arduino IDE**" workflow and see that everything goes right. If the workflow succeeds, a new release will be created automatically and you should see it on the ["**Releases**"](https://github.com/arduino/arduino-ide/releases) page.
4856

49-
### 4. ⬆️ Bump version metadata of packages
57+
### 5. ⬆️ Bump version metadata of packages
5058

5159
In order for the version number of the tester and nightly builds to have correct precedence compared to the release version, the `version` field of the project's `package.json` files must be given a patch version bump (e.g., `2.0.1` -> `2.0.2`) **after** the creation of the release tag.
5260

5361
Follow the instructions for updating the version metadata [**here**](#update-version-metadata).
5462

55-
### 5. 📄 Create the changelog
63+
### 6. 📄 Create the changelog
5664

5765
**Create GitHub issues for the known issues** that we haven't solved in the current release:
5866

@@ -71,7 +79,7 @@ Add a list of mentions of GitHub users who contributed to the release in any of
7179

7280
Add a "**Known Issues**" section at the bottom of the changelog.
7381

74-
### 6. ✎ Update the "**Software**" Page
82+
### 7. ✎ Update the "**Software**" Page
7583

7684
Open a PR on the [bcmi-labs/wiki-content](https://github.com/bcmi-labs/wiki-content) repository to update the links and texts.
7785

@@ -88,7 +96,7 @@ When the deploy workflow is done, check if links on the "**Software**" page are
8896

8997
https://www.arduino.cc/en/software#future-version-of-the-arduino-ide
9098

91-
### 7. 😎 Brag about it
99+
### 8. 😎 Brag about it
92100

93101
- Ask in the `#product_releases` **Slack** channel to write a post for the social media and, if needed, a blog post.
94102
- Post a message on the forum (ask @per1234).<br />

0 commit comments

Comments
 (0)