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.

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

feat: Metadata.licenses & Metadata.properties #1020

Merged
merged 5 commits into from
Feb 26, 2024

Conversation

AugustusKling
Copy link
Contributor

@AugustusKling AugustusKling requested a review from a team as a code owner February 24, 2024 22:24
@AugustusKling
Copy link
Contributor Author

@jkowalleck , note that I've basically guessed what could be right. It would be good if you or somebody else from your team could add a few tests cases.

@jkowalleck
Copy link
Member

[...] could add a few tests cases.

Please add test cases yourself,
they go here:

metadata: new Models.Metadata({

Please find a description how snapshot-generation works: https://github.com/CycloneDX/cyclonedx-javascript-library/tree/main/tests

thank you in advance

@jkowalleck jkowalleck linked an issue Feb 25, 2024 that may be closed by this pull request
@jkowalleck jkowalleck added the enhancement New feature or request label Feb 25, 2024
@AugustusKling
Copy link
Contributor Author

Check the provided test cases carefully to ensure they expect what should actually happen.

I've also added the npm run build command to the instructions as this was a huge time waster for me. Apparently the build task gets called automatically by npm install for whatever reason but needs to be called manually thereafter. Maybe this is just natural for NPM users but was unexpected for me.

@jkowalleck jkowalleck changed the title Add licenses and properties to CDX.Models.Metadata. #1019 feat: Metadata.licenses & Metadata.properties Feb 26, 2024
Signed-off-by: Jan Kowalleck <[email protected]>
@jkowalleck
Copy link
Member

re: #1020 (comment)

Thank you for your effort.
Now that you are kind-of familiar with the internals, feel free to pullrequest any missing feature you need 😁

See the following as some background information:

the build task gets called automatically by npm install for whatever reason.

This is to enable a usage of the package by install-from-source. This comes in handy when you want to integrate a feature branch locally in an isolated environment.
This is also to enable a feast and easy setup for people who just want to try the examples.

[...] needs to be called manually [...]

this project does test the actual build result, and therefore build and test are decoupled. You need to run both processes manually. As you already found out.
I know many projects have an auto-detected just-in-time partial-build process in memory/temp-dirs, which is error prone and lacks of testing the actual build results. This project does it properly. ;-)

Signed-off-by: Jan Kowalleck <[email protected]>
@jkowalleck jkowalleck merged commit 2e33d30 into CycloneDX:main Feb 26, 2024
38 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat: Metadata.licenses & Metadata.properties
2 participants