Skip to content

Commit

Permalink
update docs (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
emmyoop authored Sep 6, 2022
1 parent b86824c commit b03cb72
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ An exampe use is for PRs created by dependabot. You can also manually trigger t
#### Required inputs

- `GITHUB_TOKEN`: If you expect the resulting commit to add a changelog should retrigger workflows, you will need to use a Personal Access Token for the bot to commit the file. When using the GITHUB_TOKEN, the resulting commit will not trigger another GitHub Actions Workflow run. This is due to limitations set by GitHub. See [the docs](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#using-the-github_token-in-a-workflow).
- `commit_author`: Author of the commit for the changelog file. Author expected in the format "Lorem J. Ipsum <[email protected]>"
- `commit_author_name`: Author namw of the commit for the changelog file.
- `commit_author_email`: Email of the author of the commit for the changelog file.
- `changie_kind`: Type of changelog file # TODO: how does changie define this?
- `label`: GitHub label to trigger off

Expand Down Expand Up @@ -44,7 +45,7 @@ name: Changie Bot Action
on:
pull_request:
# catch when the PR is opened with the label or when the label is added
types: [opened, labeled]
types: [labeled]

permissions:
contents: write
Expand All @@ -62,7 +63,8 @@ jobs:
uses: emmyoop/[email protected]
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # could be a PAT too
commit_author: "emmyoop bot <[email protected]>"
commit_author_name: "emmyoop bot"
commit_author_email: "[email protected]"
commit_message: "My custom commit message"
changie_kind: "Bug"
label: "my_custom"
Expand Down

0 comments on commit b03cb72

Please sign in to comment.