Skip to content

Commit 9729308

Browse files
Add a changelog check in CI (#560)
* ci: Add a changelog check * docs: Update changelog
1 parent 918c59f commit 9729308

File tree

2 files changed

+20
-3
lines changed

2 files changed

+20
-3
lines changed

.github/workflows/changelog.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Changelog check
2+
3+
on:
4+
pull_request:
5+
# Run on labeled/unlabeled in addition to defaults to detect
6+
# adding/removing skip-changelog labels.
7+
types: [opened, reopened, labeled, unlabeled, synchronize]
8+
9+
jobs:
10+
changelog:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: dangoslen/changelog-enforcer@v3
14+
with:
15+
changeLogPath: CHANGELOG.md
16+
skipLabels: "skip-changelog"
17+
missingUpdateErrorMessage: "Please add a changelog entry in the CHANGELOG.md file."

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2121
- Add `--min-chip-rev` argument to specify minimum chip revision (#525)
2222
- Add `serialport` feature. (#535)
2323
- Add support for 26 MHz bootloader for ESP32 and ESP32-C2 (#553)
24+
- Add CI check to verify that CHANGELOG is updated (#560)
2425

2526
### Fixed
2627

2728
- Fixed printing panic backtraces when using `esp-println` and `defmt` (#496)
28-
- Fixed defmt parsing when data is read in parts (#503)
29+
- Fixed `defmt` parsing when data is read in parts (#503)
2930
- Use partition table instead of hard-coded values for the location of partitions (#516)
3031
- Fixed a missed `flush` call that may be causing communication errors (#521)
3132

3233
### Changed
3334
- Created `FlashData` and `FlashSettings` structs to reduce number of input arguments in some functions (#512)
34-
35-
- espflash will now exit with an error if `defmt` is selected but not usable (#524)
35+
- `espflash` will now exit with an error if `defmt` is selected but not usable (#524)
3636

3737
### Removed
3838

0 commit comments

Comments
 (0)