From 2574596fd2dfbf01438e4599abaef0167a656889 Mon Sep 17 00:00:00 2001 From: Marc Tamsky Date: Thu, 6 May 2021 17:41:57 -0700 Subject: [PATCH] fix typos, grammar, odds-ends. --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 05c3554..53ca29a 100644 --- a/README.md +++ b/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. @@ -30,7 +30,11 @@ 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 @@ -38,7 +42,7 @@ There are two blocks you will need. First you will need to generate the changelo 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 @@ -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 }}"