Skip to content

Commit 7a04d6a

Browse files
fholgerarmintaenzertng
authored andcommitted
Update README for upcoming v0.8 RC release
Signed-off-by: Holger Frydrych <holger.frydrych@tngtech.com>
1 parent 2e26b6b commit 7a04d6a

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,20 @@ CI status (Linux, macOS and Windows): [![Install and Test][1]][2]
77
[2]: https://github.com/spdx/tools-python/actions/workflows/install_and_test.yml
88

99

10-
# Current state, please read!
10+
# Breaking changes v0.7 -> v0.8
1111

12-
This repository was subject to a major refactoring recently to get ready for the upcoming SPDX v3.0 release.
13-
Therefore, we'd like to encourage you to post any and all issues you find at https://github.com/spdx/tools-python/issues.
14-
If you are looking for the source code of the [current PyPI release](https://pypi.python.org/pypi/spdx-tools), check out
15-
the [v0.7 branch](https://github.com/spdx/tools-python/tree/version/v0.7).
16-
Note, though, that this will only receive bug fixes but no new features.
12+
Please be aware that the upcoming 0.8 release has undergone a significant refactoring in preparation for the upcoming
13+
SPDX v3.0 release, leading to breaking changes in the API.
14+
Please refer to the [migration guide](https://github.com/spdx/tools-python/wiki/How-to-migrate-from-0.7-to-0.8)
15+
to update your existing code.
1716

18-
We encourage you to use the new, refactored version (on the main branch) if you
19-
- want to use the soon-to-be released SPDX v3.0 in the future
20-
- want to perform full validation of your SPDX documents against the v2.2 and v2.3 specification
21-
- want to use the RDF format of SPDX with all v2.3 features.
17+
We encourage new users to work with v0.8.0rc1 directly as the older v0.7 release is in maintenance mode.
2218

23-
If you are planning to migrate from v0.7.x of these tools,
24-
please have a look at the [migration guide](https://github.com/spdx/tools-python/wiki/How-to-migrate-from-0.7-to-0.8).
19+
The main features of v0.8 are:
20+
- experimental support for the upcoming SPDX v3 specification (note, however, that support is neither complete nor
21+
stable at this point, as the spec is still evolving)
22+
- full validation of SPDX documents against the v2.2 and v2.3 specification
23+
- support for SPDX's RDF format with all v2.3 features.
2524

2625
# Information
2726

0 commit comments

Comments
 (0)