Skip to content

Commit

Permalink
Merge pull request #90 from wibbuffey/patch-1
Browse files Browse the repository at this point in the history
Use YAML syntax highlighting in the README
  • Loading branch information
metcalfc committed Oct 22, 2021
2 parents ff0e06b + 20f9702 commit 2d09b90
Showing 1 changed file with 20 additions and 14 deletions.
34 changes: 20 additions & 14 deletions README.md
Expand Up @@ -38,28 +38,34 @@ There are two blocks you will need:

First you will need to generate the changelog itself. To get the changelog between the SHA of the commit that triggered the action and the tag of the latest release:

- name: Generate changelog
id: changelog
uses: metcalfc/changelog-generator@v1.0.0
with:
myToken: ${{ secrets.GITHUB_TOKEN }}
```yaml
- name: Generate changelog
id: changelog
uses: metcalfc/changelog-generator@v1.0.0
with:
myToken: ${{ secrets.GITHUB_TOKEN }}
```

Or, if you have two specific references you want:

- name: Generate changelog
id: changelog
uses: metcalfc/changelog-generator@v1.0.0
with:
myToken: ${{ secrets.GITHUB_TOKEN }}
head-ref: 'v0.0.2'
base-ref: 'v0.0.1'
```yaml
- name: Generate changelog
id: changelog
uses: metcalfc/changelog-generator@v1.0.0
with:
myToken: ${{ secrets.GITHUB_TOKEN }}
head-ref: 'v0.0.2'
base-ref: 'v0.0.1'
```

### Second block

Then you can use the resulting changelog:

- name: Get the changelog
run: echo "${{ steps.changelog.outputs.changelog }}"
```yaml
- name: Get the changelog
run: echo "${{ steps.changelog.outputs.changelog }}"
```

## Example use case

Expand Down

0 comments on commit 2d09b90

Please sign in to comment.