Fix formatting of generated release notes #1738
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
The "Arduino IDE" GitHub Actions workflow generates a changelog from the commits since the last tag. This changelog is published in multiple ways: - Printed to workflow run logs - Uploaded to Arduino's download server (mostly useful for the nightly builds) - Initial version of release notes For the last, the changelog text must be passed from the dedicated changelog generation workflow step to the release step. This is done via workflow job output. At the time the system was set up, outputs for workflow `run` steps were set using the `set-output` workflow command. That "workflow command" system was later determined by GitHub to have potential security vulnerabilities, so it was replaced with a `GITHUB_OUTPUT` environment file. The "Arduino IDE" workflow was migrated to the new "environment file" approach. It was later discovered that there was an undocumented breaking change in the method for handling multi-line strings in workflow step outputs between the old "workflow command" system and the new "environment file". This resulted in the initial release notes having an incorrect format. For example, what would previously have been formatted like this: - Updated translation files (#1606) [23c7f5f] - Use 0.29.0 CLI in IDE2 (#1683) [f1144ef] Was now formatted like this: - Updated translation files (#1606) [23c7f5f]%0A - Use 0.29.0 CLI in IDE2 (#1683) [f1144ef]%0A The solution is to remove the commands that did the escaping of the changelog text in a manner that is no longer supported and replace them with a "here document"-style format. A random number is used as the "delimiter" (limit string) per the security recommendations in the official GitHub documentation. Note that even though the multiline strings handling documentation was placed under the environment variable section, it also applies to setting outputs.
per1234
added
topic: infrastructure
kittaakos
approved these changes
Dec 7, 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.
Motivation
The "Arduino IDE" GitHub Actions workflow generates a changelog from the commits since the last tag.
This changelog is published in multiple ways:
For the last, the changelog text must be passed from the dedicated changelog generation workflow step to the release step. This is done via a workflow job output.
At the time the system was set up, outputs for workflow
runsteps were set using theset-outputworkflow command. That "workflow command" system was later determined by GitHub to have potential security vulnerabilities, so it was replaced with aGITHUB_OUTPUTenvironment file.The "Arduino IDE" workflow was migrated to the new "environment file" approach (#1604). It was later discovered that there was an undocumented breaking change in the method for handling multi-line strings in workflow step outputs between the old "workflow command" system and the new "environment file". This resulted in the initial release notes having an incorrect format. For example, what would previously have been formatted like this:
Was now formatted like this:
Change description
The solution is to remove the commands that did the escaping of the changelog text in a manner that is no longer supported and replace them with the "here document"-style format supported for storing multiline strings in environment files.
A random number is used as the "delimiter" (limit string) per the security recommendations in the official GitHub documentation. Note that even though the multiline strings handling documentation was placed under the environment variable section of the documentation, it also applies to setting outputs.
Other information
Demonstration release in my fork using the updated workflow:
https://github.com/per1234/arduino-ide/releases/tag/2.0.3-rc.1
Reviewer checklist