From 6f5b9494dd265d6fb7243a10c53dc0169c55f247 Mon Sep 17 00:00:00 2001 From: Jan Heinrich Reimer Date: Wed, 27 Oct 2021 14:24:37 +0200 Subject: [PATCH] Improve usage example Fix #26 --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5f6d448..81d1df8 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,19 @@ This action also makes the changelog available to other actions as [output](#out ## Example usage ```yaml -uses: heinrichreimer/github-changelog-generator-action@v2.1.1 -with: - token: ${{ secrets.GITHUB_TOKEN }} +name: Changelog +on: + release: + types: + - created +jobs: + changelog: + runs-on: ubuntu-20.04 + steps: + - name: "✏️ Generate release changelog" + uses: heinrichreimer/github-changelog-generator-action@v2.1.1 + with: + token: ${{ secrets.GITHUB_TOKEN }} ``` ## Inputs