jeans/arduino-ide
jeans/arduino-ide
1
0
Fork 0
mirror of https://github.com/arduino/arduino-ide.git synced 2025-05-02 11:17:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
arduino-ide/docs/contributor-guide/beta-testing.md
per1234 0ba88d5ab6 Move beta testing information to a dedicated documentation file 
Previously, the information about tester builds was mixed in with the documentation about building the project from
source.

The two subjects are of relevance to two distinct contribution options. Building from source will primarily be done by
developers working on the project code base. Tester builds will be used by beta testers and reviewers.

For this reason, it doesn't make sense to require beta testers to wade through a lot of development documentation not
directly related to their work in order to find the instructions for obtaining tester builds. Likewise, it doesn't make
sense to clutter up the development documentation with such information.

Moving the information about tester builds to a dedicated file makes it easier for the interested parties to find, and
also allows the creation of a comprehensive guide for beta testers without making a negative impact on the development
documentation content.
2022-09-15 05:53:09 -07:00

4.6 KiB
Raw Blame History

Beta Testing Guide

Beta testing of development versions is a valuable contribution to the project. You can help to ensure the quality of the production release that will be distributed to the user community.

Builds of the project are automatically created after every relevant change to the project in order to make it easy for anyone to participate in the testing effort.

❗ Make sure to always download the newest available tester build in order to ensure effective results from your beta testing efforts.

Beta testing is done during both the proposal (pull request) and pre-release (nightly build) phases of development:

Testing Pull Requests

Tester builds are automatically created for every pull request (PR) that proposes a relevant change.

The builds are updated if the author pushes changes to the PR.

Installation

The tester build for a PR can be downloaded by following these instructions:

  1. Sign in to your GitHub account.
    (GitHub only allows downloads of the tester builds when you are signed in.)
  2. Open the PR you are interested in.
    They are listed here:
    https://github.com/arduino/arduino-ide/pulls
  3. Click the "Checks" tab at the top of the PR's page.
  4. From the list on the left side of the page, click on "Arduino IDE".
  5. Scroll down to the "Artifacts" section of the page that opens.
  6. Click the download link for your operating system.
    ⓘ For example, if you are using Windows, click the "Windows_X86-64_zip" link.
  7. Wait for the download to finish.
  8. Extract or install the downloaded file as usual.

checks tab

tester build link

tester build artifacts

Notes for macOS

Beginning in macOS 10.14.5, the software must be notarized to run.

For security reasons, signing and notarization are disabled when creating tester builds for pull requests from forks of this repository. This means that macOS will block you from running the tester builds for those PRs.

Due to this limitation, Mac users have two options for testing PRs from forks:

The Safe Approach

Build the version of the Arduino IDE you want to test from source instead of using the automatically created tester build.

Instructions for building the project

The Risky Approach

⚠ Please note that this approach is risky as you are lowering the security on your system, therefore we strongly discourage you from following it.

  1. Use this guide, in order to disable Gatekeeper (at your own risk!).
  2. Beta test the tester build.
  3. Re-enable Gatekeeper after tests are done, following the guide linked above.

Feedback

Feedback after beta testing a pull request is always valuable, regardless of which categories your findings fall under:

  • working as expected
  • problems encountered
  • areas for improvement

Please submit feedback related to the changes made in the pull request as a PR review:

https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews

If you discover problems or areas for improvement that are unrelated to the changes made by the PR (i.e., they also occur when using the nightly build), please submit that feedback as an issue report instead of a review.

More information on issue reports

Testing Nightly Build

Builds of the project's production branch are produced daily. This build represents the current pre-release state of the project, which is planned for distribution in the next release.

Installation

  1. Open Arduino's "Software" page:
    https://www.arduino.cc/en/software#nightly-builds
  2. Select the appropriate download link from the "Nightly Builds" section of the page.
  3. Wait for the download to finish.
  4. Extract or install the downloaded file as usual.

Feedback

If you discover any problems or areas for improvement please submit an issue report.

More information on issue reports