Skip to content

Commit 4175b03

Browse files
Add CHANGELOG.md using the Keep a Changelog format (#444)
Since we started adding it only after 1.0 release, versions prior to v1.0.0 are untracked. I summarized all the changes in the v1.0.0 section instead. Signed-off-by: Mihai Maruseac <[email protected]>
1 parent ccb8456 commit 4175b03

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

CHANGELOG.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Changelog
2+
3+
All notable changes to `model-signing` will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
All versions prior to 1.0.0 are untracked.
9+
10+
## [Unreleased]
11+
12+
13+
## [1.0.0] - 2024-04-04
14+
15+
### Added
16+
- First stable release of `model_signing`.
17+
- Stable, backwards-compatible API.
18+
- Stable, clean, backwards-compatible CLI wrapping the API.
19+
- Well-defined signature scheme based on Sigstore bundle and DSSE envelope.
20+
- Well-defined, future proof, stable, in-toto format for the model signature.
21+
- Signing and verification using Sigstore, public/private key pairs, and signing certificates.
22+
- Support for signing/verification via scripts in the repo (`hatch run python -m model_signing`), installing the pip package (`python -m model_signing` or `model_signing`), or Docker containers that wrap around the CLI.
23+
- Support for Python 3.9, 3.10, 3.11, 3.12, and 3.13.
24+
- [Demo notebook](https://colab.sandbox.google.com/drive/18IB_uipduXYq0ohMxJv2xHfeihLIcGMT) to showcase API and CLI examples.
25+
26+
27+
[Unreleased]: https://github.com/sigstore/model-transparency/compare/v1.0.0...HEAD
28+
[1.0.0]: https://github.com/sigstore/model-transparency/compare/v0.1.0...v1.0.0

0 commit comments

Comments
 (0)