Skip to content

Commit fec3b11

Browse files
committed
Move release procedure documentation to more appropriate location
Previously, the procedure for creating a new release of the project was included in the development documentation. This information is distinct from the rest of the contents of that file in that it is not of any value or interest to most contributors from the community since only project maintainers will ever create a release. This meant that it make the document less readable and approachable without adding significant value in return. The information is still essential to the project maintainers, so it must not be removed, but it can be moved to a dedicated file under the existing `docs/internal/` folder that is specifically intended for storing such information.
1 parent dcc0c0a commit fec3b11

File tree

2 files changed

+31
-32
lines changed

2 files changed

+31
-32
lines changed

Diff for: BUILDING.md

-32
Original file line numberDiff line numberDiff line change
@@ -105,38 +105,6 @@ Follow [the instructions above](#build-from-source) to create the build environm
105105
1. Download the unsigned artifact provided by the CI workflow run related to the Pull Request at each push.
106106
1. Re-enable Gatekeeper after tests are done, following the guide linked above.
107107
108-
### Creating a release
109-
110-
You will not need to create a new release yourself as the Arduino team takes care of this on a regular basis, but we are documenting the process here. Let's assume the current version is `0.1.3` and you want to release `0.2.0`.
111-
112-
- Make sure the `main` state represents what you want to release and you're on `main`.
113-
- Prepare a release-candidate build on a branch:
114-
```bash
115-
git branch 0.2.0-rc \
116-
&& git checkout 0.2.0-rc
117-
```
118-
- Bump up the version number. It must be a valid [semver](https://semver.org/) and must be greater than the current one:
119-
```bash
120-
yarn update:version 0.2.0
121-
```
122-
- This should generate multiple outgoing changes with the version update.
123-
- Commit your changes and push to the remote:
124-
```bash
125-
git add . \
126-
&& git commit -s -m "Updated versions to 0.2.0" \
127-
&& git push
128-
```
129-
- Create the GH PR the workflow starts automatically.
130-
- Once you're happy with the RC, merge the changes to the `main`.
131-
- Create a tag and push it:
132-
```bash
133-
git tag -a 0.2.0 -m "0.2.0" \
134-
&& git push origin 0.2.0
135-
```
136-
- The release build starts automatically and uploads the artifacts with the changelog to the [release page](https://github.com/arduino/arduino-ide/releases).
137-
- If you do not want to release the `EXE` and `MSI` installers, wipe them manually.
138-
- If you do not like the generated changelog, modify it and update the GH release.
139-
140108
## FAQ
141109
142110
* *Can I manually change the version of the [`arduino-cli`](https://github.com/arduino/arduino-cli/) used by the IDE?*

Diff for: docs/internal/release-procedure.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Release Procedure
2+
3+
You will not need to create a new release yourself as the Arduino team takes care of this on a regular basis, but we are documenting the process here. Let's assume the current version is `0.1.3` and you want to release `0.2.0`.
4+
5+
- Make sure the `main` state represents what you want to release and you're on `main`.
6+
- Prepare a release-candidate build on a branch:
7+
```bash
8+
git branch 0.2.0-rc \
9+
&& git checkout 0.2.0-rc
10+
```
11+
- Bump up the version number. It must be a valid [semver](https://semver.org/) and must be greater than the current one:
12+
```bash
13+
yarn update:version 0.2.0
14+
```
15+
- This should generate multiple outgoing changes with the version update.
16+
- Commit your changes and push to the remote:
17+
```bash
18+
git add . \
19+
&& git commit -s -m "Updated versions to 0.2.0" \
20+
&& git push
21+
```
22+
- Create the GH PR the workflow starts automatically.
23+
- Once you're happy with the RC, merge the changes to the `main`.
24+
- Create a tag and push it:
25+
```bash
26+
git tag -a 0.2.0 -m "0.2.0" \
27+
&& git push origin 0.2.0
28+
```
29+
- The release build starts automatically and uploads the artifacts with the changelog to the [release page](https://github.com/arduino/arduino-ide/releases).
30+
- If you do not want to release the `EXE` and `MSI` installers, wipe them manually.
31+
- If you do not like the generated changelog, modify it and update the GH release.

0 commit comments

Comments
 (0)