Fix collision between macOS workflow artifacts in release workflows #2732
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.
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.md
has been updated with a migration guide (for breaking changes)configuration.schema.json
updated if new parameters are added.What kind of change does this PR introduce?
Bug fix
What is the current behavior?
GitHub Workflows are used to automatically generate and publish production and nightly releases of the project. This is done for a range of host architectures, including macOS. The macOS builds are then put through a notarization process in a dedicated workflow job.
GitHub Actions workflow artifacts are used to transfer the generated files between sequential jobs in the workflow. The "actions/upload-artifact" and "actions/download-artifact" actions are used for this purpose.
The workflow artifact handling had to be reworked recently (#2679) in order to handle a breaking change in the 4.0.0 release of the "actions/upload-artifact". Previously, a single artifact was used for the transfer of the builds for all hosts. However, support for uploading multiple times to a single artifact was dropped in version 4.0.0 of the "actions/upload-artifact" action. So it is now necessary to use a dedicated artifact for each of the builds. These are downloaded in aggregate in a subsequent job by using the artifact name globbing and merging features which were introduced in version 4.1.0 of the "actions/download-artifact" action.
A regression was introduced at that time. The chosen approach was to use a separate set of artifacts for the non-notarized and notarized files. An overview of the sequence (the prefixes are the workflow job names):
create-release-artifacts
/create-nightly-artifacts
: Generate builds.create-release-artifacts
/create-nightly-artifacts
: Upload builds to workflow artifactsnotarize-macos
: Download workflow artifacts.notarize-macos
: Notarize macOS build from downloaded artifact.notarize-macos
: Upload notarized build to workflow artifact with a different name than the source artifact.create-release
/publish-nightly
: Download workflow artifacts.create-release
/publish-nightly
: Publish builds.The problem with this is that the artifacts for the non-notarized (uploaded by the
create-release-artifacts
/create-nightly-artifacts
job) and notarized (created by thenotarize-macos
job) files are then downloaded and merged by thecreate-release
/publish-nightly
job. Since each artifact contains a file with the same path in the merged output, the contents of the last downloaded artifact overwrite the contents of the first. It happens that the non-notarized artifact is downloaded after the notarized artifact, so this file path collision results in non-notarized macOS builds being published instead of the notarized builds as intended, and as done by the workflow prior to the regression:What is the new behavior?
The chosen solution is to delete the non-notarized artifacts after downloading each in the notarize-macos jobs. An overview of the new sequence (the prefixes are the workflow job names):
create-release-artifacts
/create-nightly-artifacts
: Generate builds.create-release-artifacts
/create-nightly-artifacts
: Upload builds to workflow artifactsnotarize-macos
: Download macOS x86 or Apple Silicon workflow artifact.notarize-macos
: Delete macOS x86 or Apple Silicon workflow artifact.notarize-macos
: Notarize macOS build from downloaded artifact.notarize-macos
: Upload notarized build to workflow artifact.create-release
/publish-nightly
: Download workflow artifacts.create-release
/publish-nightly
: Publish builds.The result is that there is no file path collision when the create-release/publish-nightly job downloads and merges the artifacts.
Does this PR introduce a breaking change, and is titled accordingly?
No breaking change.
Other information
In order to facilitate the review, I made a demonstration release in my own fork, notarized with my own Apple Developer program certificate:
https://github.com/per1234/arduino-cli/actions/runs/11331487511
https://github.com/per1234/arduino-cli/releases/tag/v0.0.0-rc.2
I also triggered a run of the "Publish Nightly Build" in my fork:
https://github.com/per1234/arduino-cli/actions/runs/11331526910
The generated builds are available for download from the "Artifacts" section of the page I linked above.