-
-
Notifications
You must be signed in to change notification settings - Fork 3
Add template for running D2D on project build and source archive #30
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
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Keshav Priyadarshi <[email protected]>
|
@keshav-space We need some documentation on how to use this. |
@tdruez added usage example in the README |
Signed-off-by: Keshav Priyadarshi <[email protected]>
e9b600b to
30e80be
Compare
tdruez
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be nice to add a workflow that displays the usage of the new template on a small Python or Java.
| - [Define a custom project name](#define-a-custom-project-name) | ||
| - [Install ScanCode.io from a repository branch](#install-scancodeio-from-a-repository-branch) | ||
| - [Where does the scan results go?](#where-does-the-scan-results-go) | ||
| - [Run source to binary mapping using GitHub action template](#run-source-to-binary-mapping-using-github-action-template) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Run source to binary mapping] should be enough as a title.
| ``` | ||
|
|
||
| ### Run source to binary mapping using GitHub action template | ||
| 1. Add job to build your binary and upload it as a GitHub actions artifact. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Provide an example
| scancodeio-repo-branch: "main" | ||
| ``` | ||
|
|
||
| ### Run source to binary mapping using GitHub action template |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add some context here, what is this for, why one would run this.
| artifact-name: # Label of uploaded artifact from step 1 | ||
| steps: "python,java" # Comma separated optional steps. See https://scancodeio.readthedocs.io/en/latest/built-in-pipelines.html#map-deploy-to-develop | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a fully working examples, one for Python and one for Java for example.
Resolves: aboutcode-org/scancode.io#1774