Skip to content

Commit

Permalink
Merge pull request #65 from tamsky/patch-1
Browse files Browse the repository at this point in the history
fix typos, grammar, odds-n-ends.
  • Loading branch information
metcalfc committed Jul 12, 2021
2 parents 86b1574 + 2574596 commit d682de4
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
@@ -1,6 +1,6 @@
# Get a changelog between two references

This Action returns a markdown formatted changelog between two git references. There are other projects that use milestones, labeled PRs, etc. Those are just to much work for simple projects.
This Action returns a markdown formatted changelog between two git references. There are other projects that use milestones, labeled PRs, etc. Those are just too much work for simple projects.

I just wanted a simple way to populate the body of a GitHub Release.

Expand Down Expand Up @@ -30,15 +30,19 @@ Markdown formatted changelog.

## Example usage

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:
There are two blocks you will need:

### First block

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 }}

Or if you have two specific references you want:
Or, if you have two specific references you want:

- name: Generate changelog
id: changelog
Expand All @@ -48,7 +52,9 @@ Or if you have two specific references you want:
head-ref: 'v0.0.2'
base-ref: 'v0.0.1'

Then you can to use the resulting changelog.
### Second block

Then you can use the resulting changelog:

- name: Get the changelog
run: echo "${{ steps.changelog.outputs.changelog }}"
Expand Down

0 comments on commit d682de4

Please sign in to comment.