Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added some clairification to docs #4

Merged
merged 1 commit into from
Dec 5, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,21 @@ 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
id: changelog
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
Expand Down
2 changes: 1 addition & 1 deletion workflow.example.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down