Skip to content

Commit

Permalink
Use a good version and a real example.
Browse files Browse the repository at this point in the history
  • Loading branch information
metcalfc committed Mar 28, 2020
1 parent 19fdae0 commit 5ca0d4f
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ Next you will need to generate the changelog itself. To get the changelog betwee

- name: Generate changelog
id: changelog
uses: metcalfc/changelog-generator@v0.0.1
uses: metcalfc/changelog-generator@v0.1.1
with:
myToken: ${{ secrets.GITHUB_TOKEN }}

Or if you have two specific references you want:

- name: Generate changelog
id: changelog
uses: metcalfc/changelog-generator@v0.0.1
uses: metcalfc/changelog-generator@v0.1.1
with:
myToken: ${{ secrets.GITHUB_TOKEN }}
head-ref: 'v0.0.2'
Expand All @@ -54,3 +54,7 @@ Lastly you need to use the changelog.
run: echo "${{ steps.changelog.outputs.changelog }}"

Why do we need `myToken`? Read more here: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token#about-the-github_token-secret

## Example use case

[Generating the release notes for a GitHub Release.](.github/workflows/release.yml)

0 comments on commit 5ca0d4f

Please sign in to comment.