Added documentation and additional examples - commit signed #3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…cessfully add this Action
Signed-off-by: Paul McCarty <mcsnet@yahoo.com>
Signed-off-by: Paul McCarty <“paulm@buildstack.io”>
|
Thank you for the PR |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I wanted to flesh out the documentation for this GitHub Action a bit so that it was easier for users to add the CycloneDX action to their repositories. I added a bit of an explanation and then two additional examples: one for using the path and output parameters and one that attempts to be a complete action file with npm build and SBOM creation.