From de9988038f45d7a692c6ec7449aba62a086eac88 Mon Sep 17 00:00:00 2001
From: Jamie Smith <jsmith@crackofdawn.onmicrosoft.com>
Date: Sun, 25 Feb 2024 12:44:55 -0800
Subject: [PATCH] Prepare for release

---
 .github/workflows/github_release.yml | 26 +++++++++-
 CHANGELOG.md                         | 77 ++++++++++++++++++++++++++++
 Development Setup.md                 |  2 +-
 3 files changed, 103 insertions(+), 2 deletions(-)
 create mode 100644 CHANGELOG.md

diff --git a/.github/workflows/github_release.yml b/.github/workflows/github_release.yml
index f6233d2..bf471df 100644
--- a/.github/workflows/github_release.yml
+++ b/.github/workflows/github_release.yml
@@ -97,4 +97,28 @@ jobs:
           body_path: ./TEMP_CHANGELOG.md
           files: |
             *.whl
-            *.tar.gz
\ No newline at end of file
+            *.tar.gz
+
+  pypi-deploy:
+    name: Build and publish Python 🐍 distributions 📦 to live PyPI
+    runs-on: ubuntu-latest
+
+    environment:
+      name: release
+      url: https://pypi.org/p/cy_serial_bridge
+
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Download Artifacts
+      uses: actions/download-artifact@v4
+      with:
+        name: built-binary
+        path: dist/
+
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1.8
\ No newline at end of file
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..9645a11
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,77 @@
+# project-name Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [CHANGELOG.md][CHANGELOG.md]
+and this project adheres to [Semantic Versioning][Semantic Versioning].
+
+<!-- 
+TEMPLATE
+
+## [major.minor.patch] - yyyy-mm-dd
+
+A message that notes the main changes in the update.
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Fixed
+
+### Removed
+
+### Security
+
+_______________________________________________________________________________
+ 
+ -->
+
+<!--
+EXAMPLE
+
+## [0.2.0] - 2021-06-02
+
+Lorem Ipsum dolor sit amet.
+
+### Added
+
+- Cat pictures hidden in the library
+- Added beeswax to the gears
+
+### Changed
+
+- Updated localisation files
+
+-->
+
+_______________________________________________________________________________
+
+## [0.1.0] - 2024-02-25
+
+Initial release.  
+
+### Added
+
+- Support for I2C controller, SPI controller, and UART CDC mode via a pure Python driver.
+- Support for changing the VID, PID, and serial number of a device
+- Support for changing the type of a device
+- Device scanning
+- open_device() functiion which automatically changes the type of a device as needed
+
+[CHANGELOG.md]: https://keepachangelog.com/en/1.1.0/
+[Semantic Versioning]: http://semver.org/
+
+<!-- markdownlint-configure-file {
+    "MD022": false,
+    "MD024": false,
+    "MD030": false,
+    "MD032": false
+} -->
+<!--
+    MD022: Blanks around headings
+    MD024: No duplicate headings
+    MD030: Spaces after list markers
+    MD032: Blanks around lists
+-->
\ No newline at end of file
diff --git a/Development Setup.md b/Development Setup.md
index 38cec34..8c84b09 100644
--- a/Development Setup.md	
+++ b/Development Setup.md	
@@ -26,4 +26,4 @@ poetry run pytest -v --capture=no --log-cli-level=INFO tests/
 ```
 
 ### Uploading to PyPi
-TODO
\ No newline at end of file
+Pypy uploads will be generated automatically for releases tagged with a "vA.B.C" tag (e.g v0.1.0).
\ No newline at end of file