heinrichreimer / action-github-changelog-generator

✏️ Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
MIT License
127 stars 34 forks source link

[Question] Usage example seems to be incomplete. #26

Closed MikeVaz closed 2 years ago

MikeVaz commented 3 years ago

What you have

uses: heinrichreimer/github-changelog-generator-action@v2.1.1
with:
  token: ${{ secrets.GITHUB_TOKEN }}

Expected something like this

name: Changelog

on:
  pull_request:
    types: [closed]

  release:
    types: [published]

  issues:
    types: [closed, edited]

jobs:
  generate_changelog:
    runs-on: ubuntu-latest
    steps:
      - name: Generate change log
        uses: heinrichreimer/github-changelog-generator-action@v2.1.1
        with:
          token: ${{ secrets.GITHUB_TOKEN }} 

If you provide a full example of the workflow it would help developers to adopt this action.

heinrichreimer commented 2 years ago

Very good suggestion! Thank you :smiley: