Skip to content
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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

kne42
Copy link

@kne42 kne42 commented Apr 16, 2020

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.

@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants