CycloneDX / CycloneDX/gh-python-generate-sbom

Using a non-default input path causes the action to fail

Open
#4 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
14
Forks
4
PR merge metrics
No merged PRs in 30d

Description

When using either v1.0.0 or v1.0.1 of the action it fails when attempting to run the command to actually generate the bom. When running the 1.0.0 version of the action I get the log output:

```
Options:
i: ./xxxxx/requirements.txt
o: ./bom.xml
Running: cyclonedx-py -i ./xxxxx/requirements.txt -o ./pythonsbom.xml
usage: cyclonedx-py [-h] (-c | -cj | -e | -p | -pip | -r) [-i FILE_PATH]
[--format {xml,json}]
[--schema-version {1.4,1.3,1.2,1.1,1.0}] [-o FILE_PATH]
[-F] [-pb] [-X]
cyclonedx-py: error: one of the arguments -c/--conda -cj/--conda-json -e/--e/--environment -p/--p/--poetry -pip/--pip -r/--r/--requirements is required
Error: Command failed: cyclonedx-py -i ./xxxxx/requirements.txt -o ./bom.xml
usage: cyclonedx-py [-h] (-c | -cj | -e | -p | -pip | -r) [-i FILE_PATH]
[--format {xml,json}]
[--schema-version {1.4,1.3,1.2,1.1,1.0}] [-o FILE_PATH]
[-F] [-pb] [-X]
cyclonedx-py: error: one of the arguments -c/--conda -cj/--conda-json -e/--e/--environment -p/--p/--poetry -pip/--pip -r/--r/--requirements is required
```

That lead me to believe that since the -r flag wasn't set it was causing the command to fail. The 1.0.1 version doesn't actually give any output when it fails.

I was able to successfully generate a bom when I instead just ran the command to generate the bom in the workflow and provided it the -r flag.

If there's anything else that I can provide that would help just let me know.

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the GitHub Action with a non-default input path and compare the logged cyclonedx-py command with the successful command that includes -r. Trace where the input options are assembled; done when the action generates the BOM successfully for a non-default requirements path.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, python
Domain
ci-cd
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.