Skip to content

Add doctstring for SBOM#17756

Closed
ErniGH wants to merge 10 commits into
conan-io:develop2from
ErniGH:erni/sbom_docstring
Closed

Add doctstring for SBOM#17756
ErniGH wants to merge 10 commits into
conan-io:develop2from
ErniGH:erni/sbom_docstring

Conversation

@ErniGH

@ErniGH ErniGH commented Feb 11, 2025

Copy link
Copy Markdown
Contributor

Changelog: (Feature | Fix | Bugfix): Add doctstring for SBOM
Docs: Omit

@ErniGH ErniGH requested a review from czoido February 11, 2025 17:11
@memsharded memsharded added this to the 2.13.0 milestone Feb 12, 2025
Comment thread conan/tools/sbom/cyclonedx.py Outdated
Comment thread conan/tools/sbom/cyclonedx.py Outdated
Comment thread conan/tools/sbom/cyclonedx.py Outdated
Comment thread conan/tools/sbom/cyclonedx.py Outdated
Comment thread conan/tools/sbom/cyclonedx.py Outdated
Comment thread conan/tools/sbom/cyclonedx.py Outdated
ErniGH and others added 6 commits February 12, 2025 11:36
Co-authored-by: James <memsharded@gmail.com>
Co-authored-by: James <memsharded@gmail.com>
Co-authored-by: James <memsharded@gmail.com>
Co-authored-by: James <memsharded@gmail.com>
Co-authored-by: Carlos Zoido <mrgalleta@gmail.com>
Comment thread conan/tools/sbom/cyclonedx.py Outdated
Comment thread conan/tools/sbom/cyclonedx.py Outdated
@@ -3,6 +3,28 @@
def cyclonedx_1_4(graph, name=None, add_build=False, add_tests=False, **kwargs):
"""
(Experimental) Generate cyclone 1.4 sbom with json format

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think I would change this too, to:

(Experimental) Generate a CycloneDX 1.4 SBOM in JSON format.

Comment thread conan/tools/sbom/cyclonedx.py Outdated
Comment thread conan/tools/sbom/cyclonedx.py Outdated
Comment thread conan/tools/sbom/cyclonedx.py Outdated

@memsharded memsharded left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I have realized...

All of our conan.tools get the conanfile as first argument for a reason: This is the way that future tools.xxxx configuration via conf can be passed, as well as some internal helpers like the http requester. This might need a change to the signature of the function, to discuss:

  • Add conanfile as first argument, even if it is not needed today
  • Add graph as the second argument

This might be breaking, but better do sooner than later. We can discuss with @czoido

ErniGH and others added 3 commits February 12, 2025 12:12
Co-authored-by: Carlos Zoido <mrgalleta@gmail.com>
Co-authored-by: Carlos Zoido <mrgalleta@gmail.com>
@ErniGH ErniGH changed the base branch from develop2 to release/2.12 February 12, 2025 11:25
@ErniGH ErniGH changed the base branch from release/2.12 to develop2 February 12, 2025 11:27
@ErniGH ErniGH mentioned this pull request Feb 12, 2025
@memsharded

Copy link
Copy Markdown
Member

This is now superseded by the 2.12 patch release in #17760 can be closed.

@memsharded memsharded closed this Feb 12, 2025
@czoido czoido removed this from the 2.13.0 milestone Feb 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants