Skip to content

Commit 3c2b2a0

Browse files
committed
Format release procedure document as ordered list
The release procedure is a set of steps which must be performed in a specific sequence. This fact is more effectively communicated by formatting it as an ordered list.
1 parent 39538f1 commit 3c2b2a0

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

β€Ždocs/internal/release-procedure.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Release Procedure
22

3-
## πŸ—ΊοΈ Merge localization sync PR
3+
## 1. πŸ—ΊοΈ Merge localization sync PR
44

55
A pull request titled "**Update translation files**" is submitted periodically by the "**github-actions**" bot to pull in the localization data from [**Transifex**](https://www.transifex.com/arduino-1/ide2/dashboard/).
66

@@ -10,7 +10,7 @@ It will be shown in these search results:
1010

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

13-
## βš™ Update metadata of packages
13+
## 2. βš™ Update metadata of packages
1414

1515
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

@@ -29,7 +29,7 @@ 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
32+
## 3. 🚒 Create the release on GitHub
3333

3434
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).
3535

@@ -44,7 +44,7 @@ git push origin <YOUR_VERSION>
4444

4545
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.
4646

47-
## πŸ“„ Create the changelog
47+
## 4. πŸ“„ Create the changelog
4848

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

@@ -63,7 +63,7 @@ Add a list of mentions of GitHub users who contributed to the release in any of
6363

6464
Add a "**Known Issues**" section at the bottom of the changelog.
6565

66-
## ✎ Update the "**Software**" Page
66+
## 5. ✎ Update the "**Software**" Page
6767

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

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

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

83-
## 😎 Brag about it
83+
## 6. 😎 Brag about it
8484

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

0 commit comments

Comments
Β (0)