Skip to content

Commit e9b600b

Browse files
committed
Add documentation for D2D template
Signed-off-by: Keshav Priyadarshi <[email protected]>
1 parent 551fe98 commit e9b600b

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ from your **GitHub Workflows**.
2525
- [Check for compliance issues](#check-for-compliance-issues)
2626
- [Define a custom project name](#define-a-custom-project-name)
2727
- [Install ScanCode.io from a repository branch](#install-scancodeio-from-a-repository-branch)
28-
- [Where does the scan results go?](#where-does-the-scan-results-go)
28+
- [Run source to binary mapping using GitHub action template](#run-source-to-binary-mapping-using-github-action-template)
29+
- [Where does the scan results go?](#where-are-the-scan-results)
2930

3031
## Usage
3132

@@ -226,6 +227,18 @@ Activate this behavior by enabling `check-compliance` and setting
226227
scancodeio-repo-branch: "main"
227228
```
228229

230+
### Run source to binary mapping using GitHub action template
231+
1. Add job to build your binary and upload it as a GitHub actions artifact.
232+
2. Add a job to run `map-deploy-to-develop` pipeline.
233+
```yaml
234+
run-d2d-pipeline:
235+
needs: # Job id from step 1
236+
uses: aboutcode-org/scancode-action/.github/workflows/map-deploy-to-develop-template.yml
237+
with:
238+
artifact-name: # Lablel of uploaded artifact from step 1
239+
steps: "python,java" # Comma seprated optional steps. See https://scancodeio.readthedocs.io/en/latest/built-in-pipelines.html#map-deploy-to-develop
240+
```
241+
229242
## Where are the Scan Results?
230243

231244
Upon completion of the workflow, you can **find the scan results** in the dedicated

0 commit comments

Comments
 (0)