feat(release): document manual release procedure #2129
Conversation
kittaakos
added
topic: documentation
docs/internal/release-procedure.md
Outdated
|
|
||
| ### Ubuntu 18.04 | ||
| - Prerequisites: | ||
| - Ask the DevOps team for an EC2 instance with at least 8 GB of RAM. |
There was a problem hiding this comment.
What is the procedure for making the request?
There was a problem hiding this comment.
It's still an ongoing conversation. Once we decide how to do it, I continue with the PR.
docs/internal/release-procedure.md
Outdated
| yarn --cwd ./electron/packager && yarn --cwd ./electron/packager package | ||
| ``` | ||
| - Artifacts: | ||
| - You have to upload the following artifacts from `./arduino-ide/electron/build/dist` to S3: |
There was a problem hiding this comment.
What is the procedure for uploading things to S3?
docs/internal/release-procedure.md
Outdated
| - `arduino-ide_${VERSION}_Linux_64bit.AppImage`, | ||
| - `arduino-ide_${VERSION}_Linux_64bit.zip`, and | ||
| - `stable-linux.yml` | ||
|
|
There was a problem hiding this comment.
Add instructions to also replace the GitHub release assets with the artifacts.
| node ./scripts/merge-channel-files.js ./path/to/folder/with/channel/files | ||
| ``` | ||
| - You have the merged channel file that you need to upload to S3. | ||
|
|
There was a problem hiding this comment.
Add instructions to also replace the GitHub release assets with the artifacts.
docs/internal/release-procedure.md
Outdated
| && curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add - \ | ||
| && echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list \ | ||
| && sudo apt update && sudo apt install --no-install-recommends yarn | ||
| ``` |
There was a problem hiding this comment.
Add instructions for cloning the arduino/arduino-ide repository into the EC2 instance machine and checking out the release tag.
Co-authored-by: Akos Kitta <[email protected]> Co-authored-by: per1234 <[email protected]> Signed-off-by: Akos Kitta <[email protected]>
kittaakos
force-pushed
the
manual-release
branch
from
a3c3b84 to
726818a
Compare
Co-authored-by: per1234 <[email protected]>
Co-authored-by: per1234 <[email protected]>
Co-authored-by: per1234 <[email protected]>
Co-authored-by: per1234 <[email protected]>
ran prettier on the readme
| --- | ||
|
|
||
| - Q: How to connect to the EC2 instance? | ||
| - A: DevOps will give you a temporary link to the private key. Create a file `username_ip.pem` in your cwd, copy the private key into the file, open a shell, and execute `ssh -i "username_ip.pem" username@ip`. DevOps will tell you the `username` and the `ip`. Do not forget the VPN. |
There was a problem hiding this comment.
The chmod 0400 username_ip.pem is missing from the steps. Otherwise there is an error:
Load key "username_ip.pem": bad permissions
username@ip: Permission denied (publickey).
docs/internal/release-procedure.md
Outdated
| && codesign -dv --verbose=4 ~/Desktop/Arduino\ IDE.app \ | ||
| && ~/Desktop/Arduino\ IDE.app/Contents/MacOS/Arduino\ IDE | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Should manually rename arm to ARM before the upload: #2117
…on of automated builds for macOS ARM Previously, the production of the builds for the Apple Silicon host target was a manual procedure. This was done due to the lack of availability of GitHub hosted runner machines of that architecture. Fortunately such runners are now available, which allowed us to set up automated builds for this target. For this reason, it is no longer necessary to maintain documentation of the manual release procedure for that target.
| @@ -16,6 +16,7 @@ sudo apt update \ | |||
| libx11-dev \ | |||
| libxkbfile-dev \ | |||
| build-essential \ | |||
| libsecret-1-dev \ | |||
There was a problem hiding this comment.
Obsolete. Has been fixed via bb4b145#diff-2c7d631435546b44a958eef0364c042a88ad3066306a6591974eb68c2e65eb95R21.
Motivation
The macOS M1 and Linux 18.04 builds are manual procedures. This PR documents it; preview link.
Change description
Other information
Reviewer checklist