Skip to content

Commit e2c3e69

Browse files
authored
Changelog check (#1047)
* Add changelog check
1 parent 67f8860 commit e2c3e69

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

.github/workflows/changelog.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Changelog check
2+
3+
on:
4+
pull_request:
5+
branches: [ main ]
6+
types: [ opened, synchronize, reopened, labeled, unlabeled ]
7+
8+
jobs:
9+
Changelog-Entry-Check:
10+
name: Check Changelog Action
11+
runs-on: ubuntu-20.04
12+
steps:
13+
- uses: tarides/changelog-check-action@v1

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -327,6 +327,12 @@ make all
327327
# the ocamllsp executable can be found at _build/default/ocaml-lsp-server/bin/main.exe
328328
```
329329

330+
### Changelog
331+
332+
User-visible changes should come with an entry in the changelog under the appropriate part of
333+
the **unreleased** section. PR that doesn't provide an entry will fail CI check. This behavior
334+
can be overridden by using the "no changelog" label, which is used for changes that are not user-visible.
335+
330336
## Tests
331337

332338
To run tests execute:

0 commit comments

Comments
 (0)