diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml index cb72f98fce0..adbfcb6cceb 100644 --- a/.github/workflows/changelog.yml +++ b/.github/workflows/changelog.yml @@ -2,9 +2,16 @@ name: Changelog check on: pull_request: - # We will not track changes for the `xtask` package. + # We will not track changes for the following packages. paths-ignore: - "/xtask/" + - "/esp-build/" + - "/esp-hal-procmacros/" + - "/esp-metadata/" + - "/examples/" + - "/hil-tests/" + - "/extras/" + - "/resources/" # Run on labeled/unlabeled in addition to defaults to detect # adding/removing skip-changelog labels. types: [opened, reopened, labeled, unlabeled, synchronize] @@ -15,10 +22,122 @@ jobs: steps: - name: Checkout sources - uses: actions/checkout@v3 + uses: actions/checkout@v4 - - uses: dangoslen/changelog-enforcer@v3 + - name: Check which package is modified + uses: dorny/paths-filter@v3 + id: changes + with: + filters: | + esp-alloc: + - 'esp-alloc/**' + esp-backtrace: + - 'esp-backtrace/**' + esp-hal: + - 'esp-hal/**' + esp-hal-embassy: + - 'esp-hal-embassy/**' + esp-hal-smartled: + - 'esp-hal-smartled/**' + esp-ieee802154: + - 'esp-ieee802154/**' + esp-lp-hal: + - 'esp-lp-hal/**' + esp-println: + - 'esp-println/**' + esp-riscv-rt: + - 'esp-riscv-rt/**' + esp-storage: + - 'esp-storage/**' + esp-wifi: + - 'esp-wifi/**' + + - name: Check that changelog updated (esp-alloc) + if: steps.changes.outputs.esp-alloc == 'true' + uses: dangoslen/changelog-enforcer@v3 + with: + changeLogPath: esp-alloc/CHANGELOG.md + skipLabels: "skip-changelog" + missingUpdateErrorMessage: "Please add a changelog entry in the esp-alloc/CHANGELOG.md file." + + - name: Check that changelog updated (esp-backtrace) + if: steps.changes.outputs.esp-backtrace == 'true' + uses: dangoslen/changelog-enforcer@v3 + with: + changeLogPath: esp-backtrace/CHANGELOG.md + skipLabels: "skip-changelog" + missingUpdateErrorMessage: "Please add a changelog entry in the esp-backtrace/CHANGELOG.md file." + + - name: Check that changelog updated (esp-hal) + if: steps.changes.outputs.esp-hal == 'true' + uses: dangoslen/changelog-enforcer@v3 with: changeLogPath: esp-hal/CHANGELOG.md skipLabels: "skip-changelog" - missingUpdateErrorMessage: "Please add a changelog entry in the CHANGELOG.md file." + missingUpdateErrorMessage: "Please add a changelog entry in the esp-hal/CHANGELOG.md file." + + - name: Check that changelog updated (esp-hal-embassy) + if: steps.changes.outputs.esp-hal-embassy == 'true' + uses: dangoslen/changelog-enforcer@v3 + with: + changeLogPath: esp-hal-embassy/CHANGELOG.md + skipLabels: "skip-changelog" + missingUpdateErrorMessage: "Please add a changelog entry in the esp-hal-embassy/CHANGELOG.md file." + + - name: Check that changelog updated (esp-hal-smartled) + if: steps.changes.outputs.esp-hal-smartled == 'true' + uses: dangoslen/changelog-enforcer@v3 + with: + changeLogPath: esp-hal-smartled/CHANGELOG.md + skipLabels: "skip-changelog" + missingUpdateErrorMessage: "Please add a changelog entry in the esp-hal-smartled/CHANGELOG.md file." + + - name: Check that changelog updated (esp-ieee802154) + if: steps.changes.outputs.esp-ieee802154 == 'true' + uses: dangoslen/changelog-enforcer@v3 + with: + changeLogPath: esp-ieee802154/CHANGELOG.md + skipLabels: "skip-changelog" + missingUpdateErrorMessage: "Please add a changelog entry in the esp-ieee802154/CHANGELOG.md file." + + - name: Check that changelog updated (esp-lp-hal) + if: steps.changes.outputs.esp-lp-hal == 'true' + uses: dangoslen/changelog-enforcer@v3 + with: + changeLogPath: esp-lp-hal/CHANGELOG.md + skipLabels: "skip-changelog" + missingUpdateErrorMessage: "Please add a changelog entry in the esp-lp-hal/CHANGELOG.md file." + + - name: Check that changelog updated (esp-println) + if: steps.changes.outputs.esp-println == 'true' + uses: dangoslen/changelog-enforcer@v3 + with: + changeLogPath: esp-println/CHANGELOG.md + skipLabels: "skip-changelog" + missingUpdateErrorMessage: "Please add a changelog entry in the esp-println/CHANGELOG.md file." + + - name: Check that changelog updated (esp-riscv-rt) + if: steps.changes.outputs.esp-riscv-rt == 'true' + uses: dangoslen/changelog-enforcer@v3 + with: + changeLogPath: esp-riscv-rt/CHANGELOG.md + skipLabels: "skip-changelog" + missingUpdateErrorMessage: "Please add a changelog entry in the esp-riscv-rt/CHANGELOG.md file." + + - name: Check that changelog updated (esp-storage) + if: steps.changes.outputs.esp-storage == 'true' + uses: dangoslen/changelog-enforcer@v3 + with: + changeLogPath: esp-storage/CHANGELOG.md + skipLabels: "skip-changelog" + missingUpdateErrorMessage: "Please add a changelog entry in the esp-storage/CHANGELOG.md file." + + - name: Check that changelog updated (esp-wifi) + if: steps.changes.outputs.esp-wifi == 'true' + uses: dangoslen/changelog-enforcer@v3 + with: + changeLogPath: esp-wifi/CHANGELOG.md + skipLabels: "skip-changelog" + missingUpdateErrorMessage: "Please add a changelog entry in the esp-wifi/CHANGELOG.md file." + + diff --git a/esp-alloc/CHANGELOG.md b/esp-alloc/CHANGELOG.md new file mode 100644 index 00000000000..85894f3a362 --- /dev/null +++ b/esp-alloc/CHANGELOG.md @@ -0,0 +1,28 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +### Changed + +### Fixed + +### Removed + +## 0.4.0 - 2024-06-04 + +## 0.3.0 - 2023-04-25 + +## 0.2.1 - 2023-04-21 + +## 0.2.0 - 2023-02-22 + +## 0.1.0 - 2022-07-25 + +[Unreleased]: https://github.com/esp-rs/esp-hal/commits/main/esp-aloc?since=2024-06-05 diff --git a/esp-backtrace/CHANGELOG.md b/esp-backtrace/CHANGELOG.md index 861a1b1ed6b..512803ea392 100644 --- a/esp-backtrace/CHANGELOG.md +++ b/esp-backtrace/CHANGELOG.md @@ -5,9 +5,20 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [Unreleased] + +### Added + +### Changed + +### Fixed + +### Removed + ## 0.12.1 - 2024-06-19 ### Fixed - Fix compilation for nightly after 2024-06-12. (#1681) - Only prints float registers on targets which have them. (#1690) +[Unreleased]: https://github.com/esp-rs/esp-hal/commits/main/esp-backtrace?since=2024-06-20 diff --git a/esp-hal-embassy/CHANGELOG.md b/esp-hal-embassy/CHANGELOG.md new file mode 100644 index 00000000000..0c801483d2a --- /dev/null +++ b/esp-hal-embassy/CHANGELOG.md @@ -0,0 +1,20 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +### Changed + +### Fixed + +### Removed + +## 0.1.0 - 2024-06-04 + +[Unreleased]: https://github.com/esp-rs/esp-hal/commits/main/esp-hal-embassy?since=2024-06-05 diff --git a/esp-hal-smartled/CHANGELOG.md b/esp-hal-smartled/CHANGELOG.md new file mode 100644 index 00000000000..83bc98a6894 --- /dev/null +++ b/esp-hal-smartled/CHANGELOG.md @@ -0,0 +1,40 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +### Changed + +### Fixed + +### Removed + +## 0.11.0 - 2024-06-04 + +## 0.10.0 - 2024-04-18 + +## 0.9.0 - 2024-03-08 + +## 0.8.0 - 2024-01-19 + +## 0.7.0 - 2023-12-12 + +## 0.6.0 - 2023-10-31 + +## 0.5.0 - 2023-09-05 + +## 0.4.0 - 2023-08-10 + +## 0.3.0 - 2023-07-04 + +## 0.2.0 - 2023-05-02 + +## 0.1.0 - 2023-03-27 + +[Unreleased]: https://github.com/esp-rs/esp-hal/commits/main/esp-hal-smartled?since=2024-06-05 diff --git a/esp-ieee802154/CHANGELOG.md b/esp-ieee802154/CHANGELOG.md new file mode 100644 index 00000000000..0eac5ea47ff --- /dev/null +++ b/esp-ieee802154/CHANGELOG.md @@ -0,0 +1,18 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +### Changed + +### Fixed + +### Removed + +[Unreleased]: https://github.com/esp-rs/esp-hal/commits/main/esp-ieee802154 diff --git a/esp-println/CHANGELOG.md b/esp-println/CHANGELOG.md index df8b852cf7f..7da3ca87355 100644 --- a/esp-println/CHANGELOG.md +++ b/esp-println/CHANGELOG.md @@ -19,13 +19,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Removed -## [0.9.1] - 2024-03-11 +## 0.9.1 - 2024-03-11 ### Changed - Un-pinned the defmt package's version number -## [0.9.0] - 2024-02-07 +## 0.9.0 - 2024-02-07 ### Added @@ -35,9 +35,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Remove ESP 8266 support -## [0.8.0] - 2023-12-21 +## 0.8.0 - 2023-12-21 ### Removed - Remove RTT and defmt-raw support +[Unreleased]: https://github.com/esp-rs/esp-hal/commits/main/esp-println?since=2024-03-12 diff --git a/esp-riscv-rt/CHANGELOG.md b/esp-riscv-rt/CHANGELOG.md index 3e5652c6383..324b2a2c89d 100644 --- a/esp-riscv-rt/CHANGELOG.md +++ b/esp-riscv-rt/CHANGELOG.md @@ -65,3 +65,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## 0.2.0 - 2023-03-14 ## 0.1.0 - 2023-01-26 + +[Unreleased]: https://github.com/esp-rs/esp-hal/commits/main/esp-riscv-rt?since=2024-04-19 diff --git a/esp-storage/CHANGELOG.md b/esp-storage/CHANGELOG.md new file mode 100644 index 00000000000..fc148f80e48 --- /dev/null +++ b/esp-storage/CHANGELOG.md @@ -0,0 +1,24 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +### Changed + +### Fixed + +### Removed + +## 0.3.0 - 2023-08-16 + +## 0.2.0 - 2023-07-05 + +## 0.1.0 - 2022-09-26 + +[Unreleased]: https://github.com/esp-rs/esp-hal/commits/main/esp-storage?since=2023-08-17 diff --git a/esp-wifi/CHANGELOG.md b/esp-wifi/CHANGELOG.md index 3625a3c2e78..8d15e96e4a3 100644 --- a/esp-wifi/CHANGELOG.md +++ b/esp-wifi/CHANGELOG.md @@ -17,23 +17,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Removed -## [0.6.0] - 2024-06-04 +## 0.6.0 - 2024-06-04 ### Removed - Removed embedded-hal v0.2 dependency -## [0.5.1] - 2024-04-22 +## 0.5.1 - 2024-04-22 Patch release to fix docs.rs build -## [0.5.0] - 2024-04-19 +## 0.5.0 - 2024-04-19 ### Fixed - Fix compile error when using smoltcp `DNS_MAX_RESULT_COUNT` values other than 1 -## [0.4.0] - 2024-03-12 +## 0.4.0 - 2024-03-12 ### Changed @@ -41,7 +41,7 @@ Patch release to fix docs.rs build - Better network performance by forced yielding of the task when buffers are full / empty. (#430) - Depend on esp-hal 0.16.1, update other dependencies -## [0.3.0] - 2024-01-29 +## 0.3.0 - 2024-01-29 ### Added @@ -59,10 +59,12 @@ Patch release to fix docs.rs build ### Removed -## [0.2.0] - 2024-01-05 +## 0.2.0 - 2024-01-05 Initial release supporting WiFi on ESP32, ESP32-S2, ESP32-S3, ESP32-C3, ESP32-C2, ESP32-C6, supporting BLE on WiFi on ESP32, ESP32-S3, ESP32-C3, ESP32-C2, ESP32-C6, ESP32-H2 -## [0.1.0] - 2023-11-27 +## 0.1.0 - 2023-11-27 Initial release supporting WiFi on ESP32, ESP32-S2, ESP32-S3, ESP32-C3, ESP32-C2, ESP32-C6, supporting BLE on WiFi on ESP32, ESP32-S3, ESP32-C3, ESP32-C2, ESP32-C6 + +[Unreleased]: https://github.com/esp-rs/esp-hal/commits/main/esp-wifi?since=2024-06-05