Skip to content

Commit

Permalink
feat(action): add an output for the changelog content (#4)
Browse files Browse the repository at this point in the history
* feat: add an output for the changelog content

::set-output is
[deprecated](https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/)
in favor of [environment
files](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#environment-files).
This has better multiline support, so add the contents of the changelog as an output for cases where
you are creating a GitHub release.

BREAKING CHANGE: self-hosted runners will need to be at 2.297.0 or greater

* fix: update multiline output usage

https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#multiline-strings

* docs(readme): add content as output

Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
  • Loading branch information
mloberg and orhun authored Dec 1, 2022
1 parent b95829e commit 9b8dd77
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 3 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ This action generates a changelog based on your Git history using [git-cliff](ht
### Output variables

- `changelog`: Output file that contains the generated changelog.
- `content`: Content of the changelog.

### Environment variables

Expand Down
2 changes: 2 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ inputs:
outputs:
changelog:
description: "output file"
content:
description: "content of the changelog"
runs:
using: "docker"
image: "Dockerfile"
Expand Down
11 changes: 8 additions & 3 deletions entrypoint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,15 @@ exit_code=$?

# Output to console
cat "$OUTPUT"
OUTPUT="$WORKDIR/$OUTPUT"

# Set the changelog content
echo "content<<EOF" >> $GITHUB_OUTPUT
cat "$OUTPUT" >> $GITHUB_OUTPUT
echo "EOF" >> $GITHUB_OUTPUT

# Set output file
echo "::set-output name=changelog::$OUTPUT"
OUTPUT="$WORKDIR/$OUTPUT"
echo "changelog=$OUTPUT" >> $GITHUB_OUTPUT

# Pass exit code to the next step
echo "::set-output name=exit_code::$exit_code"
echo "exit_code=$exit_code" >> $GITHUB_OUTPUT

0 comments on commit 9b8dd77

Please sign in to comment.