Skip to content

Update README.md #7

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.

Sign up for GitHub

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

Open
smorimoto wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README.md #7

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0205ec
Update README.md
smorimoto Aug 5, 2024
15ee53f
Update README.md
smorimoto Dec 1, 2025
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
11 changes: 5 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Add this to your GitHub workflow:

```yaml
- name: Check changelog
uses: tarides/changelog-check-action@v2
uses: tarides/changelog-check-action@v3
```

### Full example
Expand All @@ -52,15 +52,14 @@ A complete `.github/workflows/changelog.yml` might look like this:
name: Check Changelog
on:
pull_request:
types: [assigned, opened, synchronize, reopened, labeled, unlabeled]
branches:
- main
types: [assigned, labeled, opened, reopened, synchronize, unlabeled]
branches: [main]
jobs:
Check-Changelog:
name: Check Changelog Action
runs-on: ubuntu-20.04
runs-on: ubuntu-latest

@Leonidas-from-XIV Leonidas-from-XIV Aug 6, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally I'd prefer not to push people to setups that might break, so I'd rather have a fixed version here.

@MisterDA MisterDA Sep 4, 2024

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For such a simple action it should be fine to use ubuntu-latest. Usually the jobs are independent, I don't think anyone is going add more steps after the changelog action, so they'll use their preferred OS.

@smorimoto smorimoto Dec 1, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes

steps:
- uses: tarides/changelog-check-action@v2
- uses: tarides/changelog-check-action@v3
with:
changelog: CHANGES.md
```