Skip to content

Commit 69eea91

Browse files
update README and CHANGELOG for the upcoming release
Signed-off-by: Armin Tänzer <[email protected]>
1 parent ef31285 commit 69eea91

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

CHANGELOG.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Changelog
22

3-
## v0.8.0rc1 (2023-06-30)
3+
## v0.8.0 (2023-07-25)
44

55
### New features and changes
66

@@ -14,6 +14,8 @@
1414
* full validation of SPDX documents against the v2.2 and v2.3 specification
1515
* support for SPDX's RDF format with all v2.3 features
1616
* unified `pysdpxtools` CLI tool replaces separate `pyspdxtools_parser` and `pyspdxtools_convertor`
17+
* [online API documentation](https://spdx.github.io/tools-python)
18+
* replaced CircleCI with GitHub Actions
1719

1820
### Contributors
1921

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ SPDX v3.0 release, leading to breaking changes in the API.
1414
Please refer to the [migration guide](https://github.com/spdx/tools-python/wiki/How-to-migrate-from-0.7-to-0.8)
1515
to update your existing code.
1616

17-
We encourage new users to work with v0.8.0rc1 directly as the older v0.7 release is in maintenance mode.
18-
1917
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)
2218
- 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.
19+
- support for SPDX's RDF format with all v2.3 features
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. SPDX3-related code is contained in a separate subpackage "spdx3"
22+
and its use is optional. We do not recommend using it in production code yet.
23+
2424

2525
# Information
2626

@@ -124,7 +124,7 @@ instead of `bin`.
124124

125125
## Example
126126
Here are some examples of possible use cases to quickly get you started with the spdx-tools.
127-
If you want a more comprehensive example about how to create an SPDX document from scratch, have a look [here](examples%2Fspdx2_document_from_scratch.py).
127+
If you want more examples, like how to create an SPDX document from scratch, have a look [at the examples folder](examples).
128128
```python
129129
import logging
130130

@@ -210,4 +210,4 @@ codebase.
210210

211211
This is the result of an initial GSoC contribution by @[ah450](https://github.com/ah450)
212212
(or https://github.com/a-h-i) and is maintained by a community of SPDX adopters and enthusiasts.
213-
In order to prepare for the release of SPDX v3.0, the repository has undergone a major refactoring during the time from 11/2022 to 03/2023.
213+
In order to prepare for the release of SPDX v3.0, the repository has undergone a major refactoring during the time from 11/2022 to 07/2023.

0 commit comments

Comments
 (0)