This repository has been archived by the owner on Mar 4, 2021. It is now read-only.
document how to create a release using the contents of a file #61
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
| @@ -42,6 +42,11 @@ jobs: | |||
| steps: | |||
| - name: Checkout code | |||
| uses: actions/checkout@master | |||
| - name: Read Release Notes | |||
| id: release_notes | |||
| juliangruber/read-file-action@v1 | |||
There was a problem hiding this comment.
Should this be uses: juliangruber/read-file-action@v1?
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Document in the README example how to use the contents of a file as the body of the release. I chose to replace the static example with one that reads from a file as I do not believe it is likely that many people will want the release notes to be the same every time.
I additionally chose to include this example as it is surprisingly non-trivial to read the contents and pass them on to the action as one will need to know how to use workflow actions and that multi-line strings need to be escaped. This points them to an action that will handle everything for them.