Skip publishing releases to AWS if credentials not configured #991
Conversation
This file contains hidden or 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
The "Publish Nightly Build" GitHub Actions workflow calculates checksums of the generated builds and writes them to a file. This file may be used to validate downloads of the builds. In addition to uploading the builds to Arduino's downloads server, the workflow also uploads them to GitHub Actions workflow artifacts. These artifacts may serve as an alternative source of the nightly builds (similar to the tester builds). Previously the checksum generation was performed in the workflow's "publish-nightly" job, which is used to upload the builds to Arduino's downloads server. In addition to being outside the stated scope of that job, this also meant that the checksum file was only available from Arduino's downloads server, and not from the workflow artifacts. Moving the checksum generation code to a dedicated job limits the operations in the important "publish-nightly" job exclusively to its stated scope. This also results in the checksum file being available as a workflow artifact.
The "Release" and "Publish Nightly Build" workflows upload the generated build files to the AWS S3 bucket used by Arduino's downloads server. The necessary credentials are configured in Arduino's repository. However, these workflows might be used in other contexts: - by contributors validating proposed changes to the release infrastructure in their fork - by hard forks of the project In either case (especially the former), the fork owner is unlikely to be willing/able to set up the AWS infrastructure that would be needed to use this capability of the workflow. Since these workflows also publish the builds to GitHub, the AWS upload is not essential to either 3rd party use case. The workflow code is hereby configured to skip the AWS upload steps if the necessary credentials have not been configured in the repository. The existence of the `AWS_ROLE_TO_ASSUME` repository secret is used as the indicator of whether the credentials are configured. This will allow runs of the workflow in forks without the need to remove the AWS upload steps.
per1234
added
type: enhancement
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The "Release" and "Publish Nightly Build" workflows upload the generated build files to the AWS S3 bucket used by Arduino's downloads server.
The necessary credentials are configured in Arduino's repository. However, these workflows might be used in other contexts:
In either case (especially the former), the fork owner is unlikely to be willing/able to set up the AWS infrastructure that would be needed to use this capability of the workflow.
Since these workflows also publish the builds to GitHub, the AWS upload is not essential to either 3rd party use case.
The workflow code is hereby configured to skip the AWS upload steps if the necessary credentials have not been configured in the repository. The existence of the
AWS_ROLE_TO_ASSUMErepository secret is used as the indicator of whether the credentials are configured. This will allow runs of the workflow in forks without the need to remove the AWS upload steps.