Skip to content

Commit

Permalink
Prepare for release
Browse files Browse the repository at this point in the history
  • Loading branch information
multiplemonomials committed Feb 25, 2024
1 parent df4ae29 commit de99880
Show file tree
Hide file tree
Showing 3 changed files with 103 additions and 2 deletions.
26 changes: 25 additions & 1 deletion .github/workflows/github_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -97,4 +97,28 @@ jobs:
body_path: ./TEMP_CHANGELOG.md
files: |
*.whl
*.tar.gz
*.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
77 changes: 77 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
-->
2 changes: 1 addition & 1 deletion Development Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ poetry run pytest -v --capture=no --log-cli-level=INFO tests/
```

### Uploading to PyPi
TODO
Pypy uploads will be generated automatically for releases tagged with a "vA.B.C" tag (e.g v0.1.0).

0 comments on commit de99880

Please sign in to comment.