From 3e1ebff27b64501acb5521fa972c630f18f88917 Mon Sep 17 00:00:00 2001 From: Donald Wasserman Date: Thu, 5 Dec 2019 08:57:02 -0500 Subject: [PATCH] Added some clairification to docs --- README.md | 5 ++--- workflow.example.yml | 2 +- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 703bb23..f526e18 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,13 @@ This is built by the team at [Next Release](https://www.nextrelease.io), but wil ## Quick Start - ```yml on: release: types: [published] jobs: generate_changelog: - runs-on: ubuntu-latest + runs-on: ubuntu-latest # Configure this based on your needs name: Update Changelog steps: - name: Create Changelog.md @@ -23,7 +22,7 @@ jobs: uses: nextrelease/next-release-changelog-action@master with: token: ${{ secrets.GITHUB_TOKEN }} # Required - changelog: 'CHANGELOG.md' # optional, default: CHANGELOG.md + changelog: "CHANGELOG.md" # optional, default: CHANGELOG.md ``` ## How It Works diff --git a/workflow.example.yml b/workflow.example.yml index fc6679f..95779b6 100644 --- a/workflow.example.yml +++ b/workflow.example.yml @@ -3,7 +3,7 @@ on: types: [published] jobs: generate_changelog: - runs-on: ubuntu-latest + runs-on: ubuntu-latest # Configure this based on your needs name: Update Changelog steps: - name: Create Changelog.md