Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Revamp CLI, add CycloneDX spec version configuration #634

Merged
merged 26 commits into from
Mar 1, 2024
Merged

Revamp CLI, add CycloneDX spec version configuration #634

merged 26 commits into from
Mar 1, 2024

Conversation

Shnatsel
Copy link
Contributor

@Shnatsel Shnatsel commented Feb 28, 2024 •
edited
Loading

  1. Show progress information from cargo metadata by default (no more "why is it taking so long?!")
  2. Switch -q to disabling progress reports, add -qq to suppress warnings (previously done by -q)
  3. Remove --output-prefix, --output-pattern, --output-cdx flags, subsumed by the newly introduced --override-filename flag
  4. Split configuration of what the SBOM describes into a separate flag --describe
  5. Make CycloneDX version configurable

Fixes #633, #605, #562, #632

@Shnatsel Shnatsel requested a review from a team as a code owner February 28, 2024 04:58
@Shnatsel
Fix -v flag description
c669a25 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Describe what the quiet flag *actually* does
79214d1 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Pass the --quiet flag on to cargo metadata
f569250 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Revert "Pass the --quiet flag on to cargo metadata"
c081264 
This reverts commit 8743160.

Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Present the cargo metadata stderr output to the user, unless silenced
d6afac1 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Drop dead logging code. It does nothing now that we use `cargo metada…
cbdf6f3 
…ta` instead of a direct dependency on Cargo internals

Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Use -q to disable progress reports and -qq to suppress warnings
fbe384c 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Fix accidentally inverted logic
736ffb1 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Update test to the new CLI
6936387 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Add Describe struct to config
70d0101 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
cargo fmt
859f6c3 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Add a CLI argument for what's being described by the SBOM
d573ece 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Replace --output-prefix, --output-pattern and --output-cdx with a mor…
e9c7779 
…e general --override-filename flag that subsumes all of them

Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Clarify target as target platform
045d6a8 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Update the configuration structs and the conversion from the CLI to c…
680cb46 
…onfig structs to match the new CLI

Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Update error message
148967b 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
If it compiles, it works!
17fc264 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Updated tests, which now pass, so it might actually work!
604fac8 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Slightly nicer CLI
21bd6ff 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Fix an edge case with filename override AND platform suffix enabled a…
ef55a55 
…t the same time producing non-compliant BOMs without .cdx extension. Previously: `bom_x86_64-unknown-linux-gnu.xml`, now: `bom_x86_64-unknown-linux-gnu.cdx.xml`

Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Add spec_version to CLI and config
a1376c2 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Wire up --spec-version
090e2c6 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel Shnatsel changed the title Revamp CLI Revamp CLI, add CycloneDX spec version configuration Feb 28, 2024
Shnatsel added a commit to Shnatsel/cyclonedx-rust-cargo that referenced this pull request Feb 28, 2024
@Shnatsel
Update the changelog with the changes from CycloneDX#634
345e2b7 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
justahero
justahero approved these changes Mar 1, 2024
View reviewed changes
Copy link
Contributor

@justahero justahero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, the CLI options feel clearer now.

lfrancke
lfrancke requested changes Mar 1, 2024
View reviewed changes
Copy link
Contributor

@lfrancke lfrancke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same minor comment twice.
I tested it and it looks good to me otherwise.

cargo-cyclonedx/src/cli.rs Show resolved Hide resolved
cargo-cyclonedx/src/cli.rs Show resolved Hide resolved
@Shnatsel
Use #[derive(clap::ValueEnum)] to provide better help text on --des…
441a90b 
…cribe argument

Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Document the default for --spec-version flag
6859a55 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Copy link
Contributor Author

Shnatsel commented Mar 1, 2024

All the review comments are addressed. Merging.

@Shnatsel
Update the README file
bc6eccb 
Signed-off-by: Sergey "Shnatsel" Davidoff <shnatsel@gmail.com>
@Shnatsel
Merge branch 'update-readme' into cli-revamp
d396947
@Shnatsel Shnatsel merged commit 9f366f6 into CycloneDX:main Mar 1, 2024
9 checks passed
@Shnatsel Shnatsel mentioned this pull request Jul 11, 2024
Open
This was referenced Aug 6, 2024
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lfrancke lfrancke lfrancke requested changes

@justahero justahero justahero approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

--output-pattern flag is confusing
3 participants
@Shnatsel @lfrancke @justahero