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.
This commit is contained in:
per1234 2022-09-24 17:00:36 -07:00
parent 39538f163f
commit 3c2b2a0734

View File

@ -1,6 +1,6 @@
# Release Procedure
## 🗺️ Merge localization sync PR
## 1. 🗺️ Merge localization sync PR
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/).
@ -10,7 +10,7 @@ It will be shown in these search results:
https://github.com/arduino/arduino-ide/pulls/app%2Fgithub-actions
## ⚙ Update metadata of packages
## 2. ⚙ Update metadata of packages
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.
@ -29,7 +29,7 @@ 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
## 3. 🚢 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).
@ -44,7 +44,7 @@ git push origin <YOUR_VERSION>
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.
## 📄 Create the changelog
## 4. 📄 Create the changelog
**Create GitHub issues for the known issues** that we haven't solved in the current release:
@ -63,7 +63,7 @@ Add a list of mentions of GitHub users who contributed to the release in any of
Add a "**Known Issues**" section at the bottom of the changelog.
## ✎ Update the "**Software**" Page
## 5. ✎ Update the "**Software**" Page
Open a PR on the [bcmi-labs/wiki-content](https://github.com/bcmi-labs/wiki-content) repository to update the links and texts.
@ -80,7 +80,7 @@ When the deploy workflow is done, check if links on the "**Software**" page are
https://www.arduino.cc/en/software#future-version-of-the-arduino-ide
## 😎 Brag about it
## 6. 😎 Brag about it
- Ask in the `#product_releases` **Slack** channel to write a post for the social media and, if needed, a blog post.
- Post a message on the forum (ask @per1234).<br />