Skip to content

Commit b2106a7

Browse files
authored
Merge pull request #208 from nokia/update-readme-help
Update README and --help
2 parents 4a5134f + c4038bf commit b2106a7

File tree

2 files changed

+8
-3
lines changed
  • tools/openchain_telco_sbom_validator

2 files changed

+8
-3
lines changed

tools/openchain_telco_sbom_validator/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
A script to validate SBOMs against
44
the [OpenChain Telco SBOM Guide](https://github.com/OpenChain-Project/Telco-WG/blob/main/OpenChain-Telco-SBOM-Guide_EN.md).
55

6+
What is new in version 0.3.2:
7+
* option `--strict-url-check` now also checks the value of the PackageChecksum if present.
8+
69
What is new in version 0.3.1:
710
* new option `--noassertion` will list fields that have value NOASSERTION,
811
* implement the strict mode for tool name and version (presence of "-"),
@@ -51,10 +54,11 @@ options:
5154
Sets a limit on the number of errors displayed.
5255
--strict-purl-check Runs a strict check on the given purls. The default behaviour is to run a non-strict purl check
5356
meaning that it is not checked if the purl is translating to a downloadable URL.
54-
--strict-url-check Runs a strict check on the URLs of the PackageHomepages. Strict check means that the validator
57+
--strict-url-check Runs a strict check on the URLs of the PackageDownloadLocation. Strict check means that the validator
5558
checks also if the given URL can be accessed. The default behaviour is to run a non-strict URL
5659
check, meaning that it is not checked if the URL points to a valid page. Strict URL check
57-
requires access to the internet and takes some time.
60+
requires access to the internet and takes some time. It also checks the value of the
61+
PackageChecksum if present.
5862
--strict Checks for both MANDATORY and RECOMMENDED fields. Default is to check MANDATORY fields only.
5963
-r, --recursive Validate recursively. Same as “--reference-logic checksum-all”.
6064
--reference-logic REFERENCE_LOGIC

tools/openchain_telco_sbom_validator/src/openchain_telco_sbom_validator/cli.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,8 @@ def parseArguments(additionalArguments: AdditionalArguments = AdditionalArgument
122122
' means that the validator checks also if the given URL can be accessed.'
123123
' The default behaviour is to run a non-strict URL check, meaning that'
124124
' it is not checked if the URL points to a valid page. Strict URL check'
125-
' requires access to the internet and takes some time.')
125+
' requires access to the internet and takes some time. It also checks'
126+
' the value of the PackageChecksum if present.')
126127
parser.add_argument('--strict', action="store_true", default=False,
127128
help='Checks for both MANDATORY and RECOMMENDED fields. Default is to check MANDATORY fields only.')
128129
parser.add_argument('--noassertion', action="store_true", default=False,

0 commit comments

Comments
 (0)