Skip to content

Commit d682de4

Browse files
authored
Merge pull request #65 from tamsky/patch-1
fix typos, grammar, odds-n-ends.
2 parents 86b1574 + 2574596 commit d682de4

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Get a changelog between two references
22

3-
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.
3+
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.
44

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

@@ -30,15 +30,19 @@ Markdown formatted changelog.
3030

3131
## Example usage
3232

33-
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:
33+
There are two blocks you will need:
34+
35+
### First block
36+
37+
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:
3438

3539
- name: Generate changelog
3640
id: changelog
3741
uses: metcalfc/[email protected]
3842
with:
3943
myToken: ${{ secrets.GITHUB_TOKEN }}
4044

41-
Or if you have two specific references you want:
45+
Or, if you have two specific references you want:
4246

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

51-
Then you can to use the resulting changelog.
55+
### Second block
56+
57+
Then you can use the resulting changelog:
5258

5359
- name: Get the changelog
5460
run: echo "${{ steps.changelog.outputs.changelog }}"

0 commit comments

Comments
 (0)