Do full run of "Arduino IDE" workflow on tag push #2177
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
per1234
added
topic: infrastructure
|
I see the "Arduino IDE" workflow run for this PR failed due to a test failure: https://github.com/arduino/arduino-ide/actions/runs/5910586435/job/16032331224#step:7:1016 This test failure also occurs on the https://github.com/arduino/arduino-ide/actions/runs/5909092994/job/16029290009#step:7:1016 So it is unrelated to the changes proposed in this pull request. |
The project was recently switched to using a "trunk-based" development strategy. This necessitated some adjustments to the configuration of the GitHub Actions workflows in order to ensure the CI system could be used to effectively validate the project at the state staged for release in the release branch. A `run-determination` job was added to the workflow. This job determines whether the conditions under which the workflow was triggered indicate that the rest of the jobs in the workflow should be run. A validation workflow should run fully under any of the following conditions: - The trigger event was something other than a branch creation - The trigger event was a release branch creation Since the project is fully validated prior to a release, running the workflow when triggered by a release tag is pointless (and even harmful in some specific standardized workflows not currently used in this repository), so (even if for no other reason than efficiency) verification workflows are configured to not run under these conditions. The standardized Arduino tooling workflows follow a modular design where each workflow has a narrow scope of purpose. That path was not taken by those who set up the infrastructure for this repository. They instead created a single massive monolithic "Arduino IDE" workflow that performs many unrelated operations under various conditions. This workflow generates releases in addition to doing validation. Even though it is pointless to run the workflow's validation operations when the workflow is triggered by a release tag, it is essential to run it for the release generation. Previously, the code used in the "Arduino IDE" workflow's `run-determination` job was configured as appropriate for a verification workflow. This meant that a release would not be generated on push of a release tag as intended. The bug is fixed by adjusting the code to do a full run of the workflow when triggered by a release tag.
per1234
force-pushed
the
build-run-determination
branch
from
5b90315
to
83405b1
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The project was recently switched to using a "trunk-based" development strategy (#2120). This necessitated some adjustments to the configuration of the GitHub Actions workflows in order to ensure the CI system could be used to effectively validate the project at the state staged for release in the release branch.
A
run-determinationjob was added to the workflow. This job determines whether the conditions under which the workflow was triggered indicate that the rest of the jobs in the workflow should be run.A validation workflow should run fully under any of the following conditions:
Since the project is fully validated prior to a release, running the workflow when triggered by a release tag is pointless (and even harmful in some specific standardized workflows not currently used in this repository), so (even if for no other reason than efficiency) verification workflows are configured to not run under these conditions.
The standardized Arduino tooling project workflows follow a modular design where each workflow has a narrow scope of purpose. That path was not taken by those who set up the infrastructure for this repository. They instead created a single massive monolithic "Arduino IDE" workflow that performs many unrelated operations under various conditions. This workflow generates releases in addition to doing validation. Even though it is pointless to run the workflow's validation operations when the workflow is triggered by a release tag, it is essential to run it for the release generation.
Previously, the code used in the "Arduino IDE" workflow's
run-determinationjob was configured as appropriate for a verification workflow. This meant that a release would not be generated on push of a release tag as intended.Change description
The bug is fixed by adjusting the code to do a full run of the workflow when triggered by a release tag.
Other information
Release made in my fork to demonstrate the functionality of the workflow with the proposed changes:
Reviewer checklist