diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e7b9dce0..237aaf33 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,10 @@ ## IMPORTANT INFORMATION +### PR Checklist + +- [ ] I have updated the CHANGELOG.md file with a description of my changes. +- [ ] I have signed the Contributor License Agreement (CLA). + ### Contributor License Agreement (CLA) * The Pull Request feature will be considered by STMicroelectronics after the signature of a **Contributor License Agreement (CLA)** by the submitter. * If you did not sign such agreement, please follow the steps mentioned in the [CONTRIBUTING.md](CONTRIBUTING.md) file. diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..f7c1212e --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,34 @@ +# 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.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +> **Note:** This changelog starts from version v1.2.0. For prior releases, refer to the +> [GitHub Releases page](https://github.com/STMicroelectronics/STSELib/releases). + +--- + +## [Unreleased](https://github.com/STMicroelectronics/STSELib/compare/v1.1.7...HEAD) - v1.2.0 + +### Breaking Changes + +- **Renamed** `stse_Handler_t` to `stse_Handle_t` — all references to the handle type must be updated in application code ([31fb0fa](https://github.com/STMicroelectronics/STSELib/commit/31fb0fa9865828d82479e8c40fa3499c68b33fe9)) +- **API change** — all platform-level SecureElement initialization functions now require an additional `void *pArg` parameter ([51aa3f8](https://github.com/STMicroelectronics/STSELib/commit/51aa3f8114d33adfe38da6fd261e4b9a71a1fa9b)) + +### Added + +### Changed + +### Deprecated + +### Removed + +### Fixed + +### Security + +--- + +## [V1.1.7 — March 4, 2026](https://github.com/STMicroelectronics/STSELib/releases/tag/v1.1.7) diff --git a/README.md b/README.md index b8052a16..3aec9fa7 100644 --- a/README.md +++ b/README.md @@ -64,10 +64,15 @@ Following applicative project can be used as reference for STSELib integration a - STSAFE-A - [stsafe-a-sdk](https://github.com/STMicroelectronics/STSAFE-A120-sdk) - [wolfssl-examples](https://github.com/wolfSSL/wolfssl-examples/tree/master/stsafe) developed and maintained by [WolfSSL](https://www.wolfssl.com/) - - [Zephyr_st-stsafe-a1xx](https://github.com/catie-aq/zephyr_st-stsafe-a1xx) developed and maintained by [CATIE](https://www.catie.fr/language/en/home/) + - [zephyr_st-stsafe-a1xx](https://github.com/catie-aq/zephyr_st-stsafe-a1xx) developed and maintained by [CATIE](https://www.catie.fr/language/en/home/) - STSAFE-L - [STSAFE-L_echo](https://github.com/STMicroelectronics/STSAFE-L_echo) - [STSAFE-L_device_authentication](https://github.com/STMicroelectronics/STSAFE-L_device_authentication) - [STSAFE-L_secure_data_storage](https://github.com/STMicroelectronics/STSAFE-L_secure_data_storage) + +## Changelog + +See [CHANGELOG.md](CHANGELOG.md) for the full history of changes. +For releases prior to v1.2.0, refer to the [GitHub Releases page](https://github.com/STMicroelectronics/STSELib/releases).