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

Trigger Changelog CI on Different Events #69

Merged
merged 9 commits into from
Oct 23, 2021
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ COPY requirements.txt /requirements.txt

RUN pip install -r requirements.txt

COPY changelog-ci.py /changelog-ci.py
COPY main.py /main.py

RUN ["chmod", "+x", "/changelog-ci.py"]
ENTRYPOINT ["python", "/changelog-ci.py"]
RUN ["chmod", "+x", "/main.py"]
ENTRYPOINT ["python", "/main.py"]
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,8 @@ your `.github/workflows/workflow.yml` file:
# defaults to `github-actions[bot]` if not provided.
committer_username: 'test'
committer_email: 'test@test.com'
env:
# optional, only required for `private` repositories
# and required if the changelog comment
# option is turned on through the config file
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
# Optional
github_token: ${{ secrets.GITHUB_TOKEN }}
```

**Changelog CI Badge:**
Expand Down Expand Up @@ -269,12 +266,12 @@ jobs:
- name: Run Changelog CI
uses: saadmk11/changelog-ci@v0.8.0
with:
# Optional
changelog_filename: CHANGELOG.md
# Optional
config_file: changelog-ci-config.json
# Add this if you are using it on a private repository
# Or if you have turned on commenting through the config file.
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
# Optional
github_token: ${{ secrets.GITHUB_TOKEN }}
```

## Changelog CI in Action (Comment & Commit)
Expand Down
9 changes: 8 additions & 1 deletion action.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,14 @@ inputs:
committer_email:
description: 'Email Address of that user who will commit'
required: false
default: '41898282+github-actions[bot]@users.noreply.github.com'
default: 'github-actions[bot]@users.noreply.github.com'
release_version:
description: 'The release version that will be used on the generated Changelog'
required: false
github_token:
description: 'GITHUB_TOKEN or Personal Access Token (PAT)'
required: true
default: ${{ github.token }}
runs:
using: 'docker'
image: 'Dockerfile'