Skip to content

Conversation

@keshav-space
Copy link
Member

@tdruez
Copy link
Contributor

tdruez commented Nov 19, 2025

@keshav-space We need some documentation on how to use this.

@keshav-space
Copy link
Member Author

@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]>
Copy link
Contributor

@tdruez tdruez left a 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)
Copy link
Contributor

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.
Copy link
Contributor

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
Copy link
Contributor

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
```

Copy link
Contributor

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.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

purl-next: Create CI/CD integration for PURL binary integrity validation

3 participants