Add change log (#421)

* Add change log * Add general info on 0.1 and 0.2 release
esp-rs · Jan 23, 2024 · 358dca4 · 358dca4
1 parent c893317
commit 358dca4
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 0 deletions.
diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml
@@ -0,0 +1,21 @@
+name: Change log 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:
+      - name: Checkout sources
+        uses: actions/checkout@v3
+
+      - 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/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -4,9 +4,15 @@ on:
   pull_request:
     branches:
       - main
+    paths-ignore:
+      - "**/CHANGELOG.md"
+      - "**/README.md"      
   push:
     branches:
       - main
+    paths-ignore:
+      - "**/CHANGELOG.md"
+      - "**/README.md"      
   workflow_dispatch:
 
 env:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,31 @@
+# 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
+
+- Include coex in list of enabled features for docs.rs (#405)
+
+### Fixed
+
+- Small correction to coex warning message (#404)
+- Use a random local port when initializing the wifi stack. (#414)
+
+### Changed
+
+- Update driver blobs (#410)
+
+### Removed
+
+## [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
+
+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