https://github.com/planetarium/changelog-check
Check if a push or a pull request contains self-describing changelog
https://github.com/planetarium/changelog-check
changelog github-app
Last synced: 19 days ago
JSON representation
Check if a push or a pull request contains self-describing changelog
- Host: GitHub
- URL: https://github.com/planetarium/changelog-check
- Owner: planetarium
- License: agpl-3.0
- Created: 2019-03-05T07:11:08.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-31T20:23:17.000Z (about 6 years ago)
- Last Synced: 2025-04-13T04:06:59.559Z (19 days ago)
- Topics: changelog, github-app
- Language: Python
- Homepage: https://github.com/apps/changelog-check
- Size: 27.3 KB
- Stars: 5
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog_check.py
- License: LICENSE
Awesome Lists containing this project
README
Changelog Check
===============
This GitHub app checks if a push or a pull request contains self-describing
changelog. A log needs to be written in a changelog file.
Changelog file
--------------
A changelog file is automatically detected by its filename. If a filename
looks like *CHANGES* or *ChangeLog*, no matter its case or file extension,
it is treated as a changelog file.
Skipping check
--------------
Sometimes a commit or a pull request has only a trivial change. To skip
changelog check, add `[changelog skip]` (or `[skip changelog]`) to a commit
message. It does not necessarily have to be the first line.
In case of a pull request, a skip mark works for any commit in the pull request.
FYI the syntax follows the convention of `[ci skip]`.
Source code
-----------
This app is distributed under [AGPL 3] or later. See the source repository:
[AGPL 3]: https://www.gnu.org/licenses/agpl-3.0.html