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

feat: Add license text as evidence #1243

Merged
merged 19 commits into from
Dec 17, 2024
Merged

feat: Add license text as evidence #1243

merged 19 commits into from
Dec 17, 2024

Conversation

cuhland
Copy link
Contributor

@cuhland cuhland commented Dec 10, 2024 •
edited by jkowalleck
Loading

fixes #256

This PR is based on #427, and uses the same implementation as it was implemented in yarn (See CycloneDX/cyclonedx-node-yarn#193)
closes #427

Matthias Schiebel and others added 9 commits December 4, 2024 17:18
@cuhland
FEAT: Option to add license text to BOM output (CycloneDX#256)
839c3f1 
Signed-off-by: Matthias Schiebel <[email protected]>
Signed-off-by: Christoph Uhland <[email protected]>
@cuhland
Changed approach to find license text files to be case-insensitive
1c6e925 
Signed-off-by: Matthias Schiebel <[email protected]>
Signed-off-by: Christoph Uhland <[email protected]>
@cuhland
Fix missing dependency
dfd9436 
Signed-off-by: Christoph Uhland <[email protected]>
Signed-off-by: Christoph Uhland <[email protected]>
@cuhland
Bring option to BomBuilderOption
d71db34 
address design principles and architecture of this project.
Still wip

Signed-off-by: Christoph Uhland <[email protected]>
Signed-off-by: Christoph Uhland <[email protected]>
@cuhland
Call the license text addition while building the component
74e8566 
Signed-off-by: Christoph Uhland <[email protected]>
@cuhland
Refactor: Create LicenseBuilder
6e81cc3 
As suggested in CycloneDX#427 (comment)

Signed-off-by: Christoph Uhland <[email protected]>
@cuhland
Align option to name in yarn
9509857 
Signed-off-by: Christoph Uhland <[email protected]>
@cuhland
Use the evidence for the content of the license
5f9d891 
Signed-off-by: Christoph Uhland <[email protected]>
@cuhland
Bring back the declared
05aadf6 
Signed-off-by: Christoph Uhland <[email protected]>
@cuhland cuhland requested a review from a team as a code owner December 10, 2024 15:43
@cuhland
Remove minimatch dependency
5a70ac2 
Signed-off-by: Christoph Uhland <[email protected]>
jkowalleck
jkowalleck requested changes Dec 10, 2024
View reviewed changes
Copy link
Member

@jkowalleck jkowalleck left a comment

Choose a reason for hiding this comment

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

Thank you for all of your efforts, @cuhland .

some changes/refactors are needed, please see my remarks below.

Also, please add the appropriate test-beds. I could expect this can be trickt. let me know if you need help with this.

src/builders.ts Outdated Show resolved Hide resolved
src/builders.ts Outdated Show resolved Hide resolved
src/builders.ts Outdated Show resolved Hide resolved
src/builders.ts Outdated Show resolved Hide resolved
src/cli.ts Show resolved Hide resolved
tests/_data/dummy_projects/with-lockfile/package-lock.json Outdated Show resolved Hide resolved
tests/_data/dummy_projects/with-shrinkwrap/npm-shrinkwrap.json Outdated Show resolved Hide resolved
@jkowalleck jkowalleck added this to the v2.0.0 milestone Dec 10, 2024
@jkowalleck jkowalleck added the enhancement New feature or request label Dec 10, 2024
@cuhland
Remove modifications in dummy projects
fc97d2a 
Signed-off-by: Christoph Uhland <[email protected]>
@cuhland
Remove unintended change
97bc898 
Signed-off-by: Christoph Uhland <[email protected]>
@cuhland
Move to _helpers.ts
e58595c 
Signed-off-by: Christoph Uhland <[email protected]>
@cuhland
Simplified as suggested
a623d32 
Signed-off-by: Christoph Uhland <[email protected]>
@cuhland
Make a generator
282c81c 
Signed-off-by: Christoph Uhland <[email protected]>
jkowalleck
jkowalleck requested changes Dec 16, 2024
View reviewed changes
src/builders.ts Outdated Show resolved Hide resolved
src/builders.ts Outdated Show resolved Hide resolved
@cuhland
Create unit test
ee41ee6 
Signed-off-by: Christoph Uhland <[email protected]>
@cuhland
Move to helpers
3975683 
Signed-off-by: Christoph Uhland <[email protected]>
@cuhland
Move fetchLicenseEvidence to BomBuilder
ac1216c 
Signed-off-by: Christoph Uhland <[email protected]>
@jkowalleck
Copy link
Member

some code styles are not applied as expected. see https://github.com/CycloneDX/cyclonedx-node-npm/actions/runs/12370296220/job/34526888496?pr=1243
could you run npm run cs-fix, @cuhland ?

@cuhland
Fix code style
2e51881 
Signed-off-by: Christoph Uhland <[email protected]>
@jkowalleck
Copy link
Member

@cuhland , i will merge the feature soon, so it will be part of the next release.

next release is planned for January 2025.
Do you need a pre-release published for some early testing?

@cuhland
Copy link
Contributor Author

cuhland commented Dec 17, 2024

@cuhland , i will merge the feature soon, so it will be part of the next release.

next release is planned for January 2025. Do you need a pre-release published for some early testing?

Thanks.
I can wait for the next release.

@jkowalleck jkowalleck removed this from the v2.0.0 milestone Dec 17, 2024
@jkowalleck jkowalleck merged commit 0c7e2d4 into CycloneDX:main Dec 17, 2024
3 checks passed
This was referenced Dec 17, 2024
Closed
Open
Merged
@CompartMSL
Copy link

@cuhland and @jkowalleck - Thanks for integrating the --gather-license-texts option.

jkowalleck added a commit that referenced this pull request Dec 18, 2024
@jkowalleck
refactor: copy/past mime-helpers (#1246)
c0c3f7d 
followup of #1243

make implementation a copy-past of existing art:
<https://github.com/CycloneDX/cyclonedx-node-yarn/blob/main/src/_helpers.ts>

this should make it easier for
CycloneDX/cyclonedx-javascript-library#1162

---------

Signed-off-by: Jan Kowalleck <[email protected]>
@jkowalleck
Copy link
Member

this feature was released via v1.20.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jkowalleck jkowalleck jkowalleck approved these changes

Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

FEAT: Option to add license text to SBOM result
3 participants
@cuhland @jkowalleck @CompartMSL