diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml new file mode 100644 index 00000000..b873110b --- /dev/null +++ b/.github/workflows/changelog.yml @@ -0,0 +1,17 @@ +name: Changelog check + +on: + pull_request: + # Run on labeled/unlabeled in addition to defaults to detect + # adding/removing skip-changelog labels. + types: [opened, reopened, labeled, unlabeled, synchronize] + +jobs: + changelog: + runs-on: ubuntu-latest + steps: + - uses: dangoslen/changelog-enforcer@v3 + with: + changeLogPath: CHANGELOG.md + skipLabels: "skip-changelog" + missingUpdateErrorMessage: "Please add a changelog entry in the CHANGELOG.md file." diff --git a/CHANGELOG.md b/CHANGELOG.md index 2ca99e63..5d6fb184 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,18 +21,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Add `--min-chip-rev` argument to specify minimum chip revision (#525) - Add `serialport` feature. (#535) - Add support for 26 MHz bootloader for ESP32 and ESP32-C2 (#553) +- Add CI check to verify that CHANGELOG is updated (#560) ### Fixed - Fixed printing panic backtraces when using `esp-println` and `defmt` (#496) -- Fixed defmt parsing when data is read in parts (#503) +- Fixed `defmt` parsing when data is read in parts (#503) - Use partition table instead of hard-coded values for the location of partitions (#516) - Fixed a missed `flush` call that may be causing communication errors (#521) ### Changed - Created `FlashData` and `FlashSettings` structs to reduce number of input arguments in some functions (#512) - -- espflash will now exit with an error if `defmt` is selected but not usable (#524) +- `espflash` will now exit with an error if `defmt` is selected but not usable (#524) ### Removed