Use multi-line $GITHUB_OUTPUT syntax for the changelog entry output
#692
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
…tput The changelog entry is multi-line, so we need to use the multi-line syntax when using the `$GITHUB_OUTPUT` file. This resolves: ``` Error: Unable to process file command 'output' successfully. Error: Invalid format '### Added' ``` See: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#multiline-strings GUS-W-14177169.
Malax
approved these changes
Sep 25, 2023
colincasey
pushed a commit
to heroku/languages-github-actions
that referenced
this pull request
Feb 1, 2024
Currently if the `git log` generated to populate the PR description contains more than one commit, the workflow fails with errors like: ``` Error: Unable to process file command 'output' successfully. Error: Invalid format '- Migrate from CircleCI to GHA (#214)' ``` This is because of the GitHub Actions gotcha around multi-line strings when using `GITHUB_OUTPUT` (or `GITHUB_ENV`): https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#multiline-strings This didn't come up during testing, since the repo I tried with didn't have multiple commits on `main` since the last tag. See also: heroku/heroku-buildpack-nodejs#1153 heroku/libcnb.rs#692 GUS-W-14894410.
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 changelog entry is multi-line, so we need to use the multi-line syntax when using the
$GITHUB_OUTPUTfile.This resolves:
(from https://github.com/heroku/libcnb.rs/actions/runs/6299338275/job/17099895465#step:9:9)
See:
https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter
https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#multiline-strings
GUS-W-14177169.