-
-
Notifications
You must be signed in to change notification settings - Fork 405
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(release): document manual release procedure #2129
Changes from all commits
726818a
a84dc88
bce12dd
ebb115c
24b0212
6722972
cddb18e
c7d8e88
1a34e50
8959aec
9d99d14
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -174,3 +174,73 @@ git push origin version-<YOUR_VERSION> | |
``` | ||
|
||
replacing `<YOUR_VERSION>` with the version you want. Then create a PR and merge it. | ||
|
||
## Manual build | ||
|
||
Creating the release for Ubuntu 18.04 ([arduino/arduino-ide#2018](https://github.com/arduino/arduino-ide/issues/2018)) is a manual procedure: | ||
|
||
- Prerequisites: | ||
- Ask the DevOps team for an EC2 instance with at least 8 GB of RAM. | ||
- Your account must have access to the staging AWS environment. | ||
- You have VPN connection to staging. | ||
- Setup: | ||
|
||
- To install all required dependencies, run the following script: | ||
```sh | ||
sudo apt update \ | ||
&& sudo apt install --no-install-recommends --yes \ | ||
git \ | ||
gcc \ | ||
curl \ | ||
make \ | ||
python \ | ||
pkg-config \ | ||
libx11-dev \ | ||
libxkbfile-dev \ | ||
build-essential \ | ||
libsecret-1-dev \ | ||
&& wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash \ | ||
&& source ~/.bashrc \ | ||
&& nvm install 16 \ | ||
&& nvm use 16 \ | ||
&& nvm alias default 16 \ | ||
&& 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 | ||
``` | ||
|
||
- Clone: | ||
|
||
```sh | ||
BRANCH="<TODO: release branch name>" | ||
git clone --single-branch --branch $BRANCH https://github.com/arduino/arduino-ide.git | ||
``` | ||
|
||
- Build: | ||
|
||
```sh | ||
export IS_RELEASE=true \ | ||
&& export CI=true \ | ||
&& ./scripts/package.sh | ||
``` | ||
|
||
- Artifacts: | ||
- You have to upload the following artifacts from `./arduino-ide/electron-app/dist` to S3: | ||
- `arduino-ide_${VERSION}_Linux_64bit.AppImage`, | ||
- `arduino-ide_${VERSION}_Linux_64bit.zip`, and | ||
- `stable-linux.yml` | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add instructions to also replace the GitHub release assets with the artifacts. |
||
### FAQ | ||
|
||
- Q: I see no `stable` channel files, only `latest`. | ||
- A: You forgot to set the `CI=true` environment variable. | ||
|
||
--- | ||
|
||
- 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The
|
||
|
||
--- | ||
|
||
- Q: How to download the files from the EC2 instance? | ||
- A: `scp -i username_ip.pem username@ip:/path/to/build/artifact /local/dir`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Obsolete. Has been fixed via bb4b145#diff-2c7d631435546b44a958eef0364c042a88ad3066306a6591974eb68c2e65eb95R21.