feat!: v5.0.0 #440
Merged
feat!: v5.0.0 #440
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferences |
Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
jkowalleck
force-pushed
the
5.0.0-dev
branch
2 times, most recently
from
6a6598e to
3de2493
Compare
fixes #442 part of #446 BREAKING CHANGE Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
This was
linked to
issues
Sep 21, 2023
Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
jkowalleck
force-pushed
the
5.0.0-dev
branch
from
be40417 to
18b4eca
Compare
Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
If a LicenseExpression is set, then there must be no other license. fixes #453 Signed-off-by: Jan Kowalleck <[email protected]>
add indention to outputters. this may come at a cost! Breaking Changes ------------------ * abstract Method `output.BaseOutput.output_as_string()` got new optional kwarg `indent` * abstract Method `output.BaseOutput.output_as_string()` accepts arbitrary kwargs Changed ---------- * XML output uses a default namespace, which makes results smaller. Added ------------------ * All outputters' method `output_as_string()` got new optional kwarg `indent` * All outputters' method `output_as_string()` accepts arbitrary kwargs * All outputters' method `output_to_file()` got new optional kwarg `indent` * All outputters' method `output_to_file()` accepts arbitrary kwargs ----- - [x] implementation - [x] tests (snapshot binary compare; structural equal compare) ----- enables CycloneDX/cyclonedx-python#424 fixes #437 fixes #438 supersedes #449 --------- Signed-off-by: Jan Kowalleck <[email protected]>
…are (#464) part of #437 also fixed a bug: unused first level dependencies were not detected. now they are. --------- Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
breaking changes
------------------
* Reworked license related models and collections
* API
* Removed class `factory.license.LicenseChoiceFactory`
The old functionality was integrated into `factory.license.LicenseFactory`.
* Method `factory.license.LicenseFactory.make_from_string()`'s parameter `name_or_spdx` was renamed to `value`
* Method `factory.license.LicenseFactory.make_from_string()`'s return value can also be a `LicenseExpression`
The behavior imitates the old `factory.license.LicenseChoiceFactory.make_from_string()`
* Renamed class `module.License` to `module.license.DisjunctliveLicense`
* Removed class `module.LicenseChoice`
Use dedicated classes `module.license.DisjunctliveLicense` and `module.license.LicenseExpression` instead
* All occurrences of `models.LicenseChoice` were replaced by `models.licenses.License`
* All occurrences of `SortedSet[LicenseChoice]` were specialized to `models.license.LicenseRepository`
fixes
------------------
* serialization of multy-licenses #365
added
------------------
* API
* Method `factory.license.LicenseFactory.make_with_expression()`
* Class `model.license.DisjunctiveLicense`
* Class `model.license.LicenseExpression`
* Class `model.license.LicenseRepository`
* Class `serialization.LicenseRepositoryHelper`
tests
------------------
* added regression test for bug #365
misc
------------------
* raised dependency `py-serializable@^9.15`
----
fixes #365
~~BLOCKED by a feature request to serializer: <https://github.com/madpah/serializable/pull/32>~~
---------
Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
Automatically generated by python-semantic-release Signed-off-by: semantic-release <semantic-release>
Signed-off-by: Jan Kowalleck <[email protected]>
- restructured validators, to enable possible non-schema-based validation. - optimized `validation.schema.get_instance()` - optimized `output.get_instance()` --------- Signed-off-by: Jan Kowalleck <[email protected]>
- deprecate function `output.get_instance()` - add function `outout.make_outputter()` - rename function `validation.get_instance()` -> `validation.make_schemabased_validator()` - rename function `validation.schema.get_instance()` -> `validation.make_schemabased_validator()` --------- Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
- raised some dev tools - added more quality checkers and rules - documented and applied additional code standards --------- Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
Signed-off-by: Jan Kowalleck <[email protected]>
Automatically generated by python-semantic-release Signed-off-by: semantic-release <semantic-release>
Signed-off-by: Jan Kowalleck <[email protected]>
--------- Signed-off-by: Jan Kowalleck <[email protected]>
jkowalleck
added
documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
BREAKING CHANGES
model.bom.Bom.validate()will throwexception.LicenseExpressionAlongWithOthersException, if detecting invalid license constellation (#453 via #452)schema.SchemaVersionis no longer string-like (#442 via #447)schema.OutputVersionis no longer string-like (#442 via #447)output.BaseOutputrequires implementation of new methodoutput_format(#446 via #447)output.BaseOutput.output_as_string()got new optional parameterindent(#437 via #458)output.BaseOutput.output_as_string()accepts arbitrary kwargs (via #458, #462)factory.license.LicenseChoiceFactory(via #466)The old functionality was integrated into
factory.license.LicenseFactory.factory.license.LicenseFactory.make_from_string()'s parametername_or_spdxwas renamed tovalue(via #466)factory.license.LicenseFactory.make_from_string()'s return value can also be aLicenseExpression(#365 via #466)The behavior imitates the old
factory.license.LicenseChoiceFactory.make_from_string()module.Licensetomodule.license.DisjunctliveLicense(#365 via #466)module.LicenseChoice(#365 via #466)Use dedicated classes
module.license.DisjunctliveLicenseandmodule.license.LicenseExpressioninsteadmodels.LicenseChoicewere replaced bymodels.licenses.License(#365 via #466)SortedSet[LicenseChoice]were specialized tomodels.license.LicenseRepository(#365 via #466)Fixed
model.bom.validate()(via #464)Changed
These files were never intended for public use.
Added
The functionality might require additional dependencies, that can be installed with the extra "validation".
See the docs in section "Installation" for details.
output.make_outputter()(via #469)This replaces the deprecated function
output.get_instance().validation(#432, #446 via #433, #448, #469, #468, #469)exception.MissingOptionalDependencyException(#432 via #433)exception.LicenseExpressionAlongWithOthersException(#453 via #452)output.{json,xml}.BY_SCHEMA_VERSION(#446 via #447)output.BaseOutputnow have a new methodoutput_format(#446 via #447)output.BaseOutput.output_as_string()got new optional parameterindent(#437 via #458)output.BaseOutput.output_to_file()got new optional parameterindent(#437 via #458)factory.license.LicenseFactory.make_with_expression()(via #466)model.license.DisjunctiveLicense(#365 via #466)model.license.LicenseExpression(#365 via #466)model.license.LicenseRepository(#365 via #466)serialization.LicenseRepositoryHelper(#365 via #466)Deprecated
output.get_instance()might be removed, useoutput.make_outputter()instead (via #469)Tests
Misc
py-serializable@^0.15.0, was@^0.11.1(via #458, #463, #464, #466)