From 20f97024e8b0e52969f4d89fd5168f49feba99b9 Mon Sep 17 00:00:00 2001 From: wibbuffey <63820638+wibbuffey@users.noreply.github.com> Date: Thu, 21 Oct 2021 23:27:43 -0400 Subject: [PATCH] format code with yaml --- README.md | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 0076ce2..9010c8b 100644 --- a/README.md +++ b/README.md @@ -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