|
| 1 | +# Release Procedure |
| 2 | + |
| 3 | + |
| 4 | +## Steps |
| 5 | + |
| 6 | +The following are the steps to follow to make a release of Arduino App CLI: |
| 7 | + |
| 8 | +### 1. Create the pre-release on GitHub |
| 9 | + |
| 10 | +You need to **create and push the new tag** and wait for the pre-release to appear on [the "**Releases**" page](https://github.com/arduino/arduino-app-cli/releases). |
| 11 | + |
| 12 | + |
| 13 | +1. Checkout the release branch in the repository. |
| 14 | +1. Run the following commands: |
| 15 | + ```text |
| 16 | + git pull |
| 17 | + git tag -a <YOUR_VERSION> -m "<YOUR_VERSION>" |
| 18 | + git push origin <YOUR_VERSION> |
| 19 | + ``` |
| 20 | + |
| 21 | +Pushing a tag will trigger a **GitHub Actions** workflow on the `main` branch. Check the "**Arduino App CLI**" workflow and see that everything goes right. If the workflow succeeds, a new pre-release will be created automatically and you should see it on the ["**Releases**"](https://github.com/arduino/arduino-app-cli/releases) page. |
| 22 | + |
| 23 | +### 2. ✅ Validate the pre-relaese |
| 24 | + |
| 25 | +- Ask in the #ft_swc_qa_requests Slack channel to perform QA testing |
| 26 | +- Write a message in the #general Slack channel: |
| 27 | + |
| 28 | + |
| 29 | +### 3. 🚢 Create the release on GitHub |
| 30 | + |
| 31 | +### 4. 📄 Create the changelog |
| 32 | + |
| 33 | +Edit the `CHANGELOG.md` file following the **Keep A Changelog** scheme: |
| 34 | + |
| 35 | +https://keepachangelog.com/en/1.0.0/#how |
| 36 | + |
| 37 | +Add a list of mentions of GitHub users who contributed to the release in any of the following ways (ask @per1234): |
| 38 | + |
| 39 | +- Submitted a PR that was merged |
| 40 | +- Made a valuable review of a PR |
| 41 | +- Submitted an issue that was resolved |
| 42 | +- Provided valuable assistance with the investigation of an issue that was resolved |
| 43 | + |
| 44 | +Add a "**Known Issues**" section at the bottom of the changelog. |
| 45 | + |
| 46 | + |
| 47 | + |
| 48 | +### 3. 😎 Brag about it |
| 49 | +- Write a message in the `#ft_swc_deploy` **Slack** channel: |
| 50 | + > Hey **Arduino**s! Updates from the **Tooling Team** :hammer_and_wrench: |
| 51 | + > |
| 52 | + > Arduino App CLU 0.6.8 is out! :doge: You can download it from the [Download Page](https://github.com/arduino/arduino-app-cli/releases) |
| 53 | + > The highlights of this release are: |
| 54 | + > |
| 55 | + > - add the ardino-app-cli board monitor command |
| 56 | + > - improvement of Serial Monitor performances |
| 57 | + > - ardiuno-cli upgrade |
| 58 | + > - some bugfixing |
| 59 | + > |
| 60 | + > To see the details, you can take a look at the [Changelog](https://github.com/arduino/arduino-app-cli/blob/main/CHANGELOG.md) |
0 commit comments