Skip to content

Commit

Permalink
Add linter for CHANGELOG formatting
Browse files Browse the repository at this point in the history
There have been a number of recent commits introducing incorrectly
formatted CHANGELOG entries:
- 9f0b8eb was missing an author
- 936a862 had trailing whitespace
- 238432d had wrong number of leading whitespace
- 51852d2 had wrong number of leading whitespace in the header

To prevent these inconsistencies from happening in the future, I wrote a
small linter for CHANGELOG files that catches all of the above errors.
  • Loading branch information
skipkayhil committed Jul 27, 2022
1 parent 2e8f4cb commit a477096
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,22 @@ permissions:
contents: read

jobs:
changelog-formatting:
name: Check CHANGELOGs formatting
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
repository: skipkayhil/rails-bin
ref: 44270430c14385fd7db002b47f0819af5d824352
- uses: ruby/setup-ruby@v1
with:
ruby-version: 3.1
bundler-cache: true
- uses: actions/checkout@v3
with:
path: rails
- run: bin/check-changelogs ./rails
codespell:
name: Check spelling all files with codespell
runs-on: ubuntu-latest
Expand Down

0 comments on commit a477096

Please sign in to comment.