Remove irrelevant trigger from "Compose full changelog" workflow #886
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
The "Compose full changelog" GitHub Actions workflow generates a changelog file from the release notes and uploads this to Arduino's server for display to the user by the IDE updater. Previously, this workflow could be triggered by either of two events: - Release creation - Release edit To reduce the possibility of endless recursion, GitHub Actions ignores events which are triggered using the auto-generated `GITHUB_TOKEN` access token. All release creations are done automatically by the "Arduino IDE" GitHub Actions workflow, which uses this token. For this reason, the release creation trigger will never be used. Since the behavior of the event being ignored by GitHub Actions under these conditions is not at all obvious, having the workflow configured for such an irrelevant trigger can cause confusion. The workflow will be triggered by the manual edit which is done on every release to format the raw release notes auto-generated from the commit history. So the fact that the release creation trigger doesn't work is not a problem.
per1234
added
type: enhancement
silvanocerza
approved these changes
Mar 4, 2022
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.
The "Compose full changelog" GitHub Actions workflow generates a changelog file from the release notes and uploads this to Arduino's server for display to the user by the IDE updater.
Previously, this workflow could be triggered by either of two types of
releaseevent:Motivation
To reduce the possibility of endless recursion, GitHub Actions ignores events which are triggered using the auto-generated
GITHUB_TOKENaccess token:https://docs.github.com/en/actions/using-workflows/triggering-a-workflow#triggering-a-workflow-from-a-workflow
All release creations are done automatically by the "Arduino IDE" GitHub Actions workflow, which uses this token.
For this reason, the release creation trigger will never be used. Since the behavior of the event being ignored by GitHub Actions under these conditions is not at all obvious, having the workflow configured for such an irrelevant trigger can cause confusion.
Change description
Remove the irrelevant trigger from the workflow.
The workflow will be triggered by the manual edit which is done on every release to format the raw release notes auto-generated from the commit history. So the fact that the release creation trigger doesn't work is not a problem.
Reviewer checklist