Skip to content

Commit 7d76d22

Browse files
committed
squash: Update release notes
Signed-off-by: David Feltell <[email protected]>
1 parent 3c9331a commit 7d76d22

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

RELEASE_NOTES.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,36 @@
11
Release Notes
22
=============
33

4+
v1.0.0-alpha.x
5+
--------------
6+
7+
### Breaking changes
8+
9+
- Updated the YAML schema to group traits/specifications under a version
10+
number key.
11+
[#80](https://github.com/OpenAssetIO/OpenAssetIO-TraitGen/issues/80)
12+
13+
### New features
14+
15+
- Added support for trait versioning. Suffixed generated
16+
trait/specification view classes with a `_vX` and trait IDs with a `.vX`
17+
(where `X` is a version number), except for the first version of a
18+
trait, where the ID has no version suffix, retaining backward
19+
compatibility.
20+
[#80](https://github.com/OpenAssetIO/OpenAssetIO-TraitGen/issues/80)
21+
22+
- Added an optional `deprecated` field to trait and specification YAML
23+
definitions, which causes a deprecation warning/annotation to be
24+
generated for all versions of that trait/specification.
25+
[#80](https://github.com/OpenAssetIO/OpenAssetIO-TraitGen/issues/80)
26+
27+
### Improvements
28+
29+
- Updated classes without a version suffix to alias version 1, but with
30+
a deprecation warning/annotation, for backward compatibility.
31+
[#80](https://github.com/OpenAssetIO/OpenAssetIO-TraitGen/issues/80)
32+
33+
434
v1.0.0-alpha.12
535
--------------
636

0 commit comments

Comments
 (0)