Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
activity

GitHub Action

Run ORT

v0.1.0 Pre-release

Run ORT

activity

Run ORT

Run oss-review-toolkit to review Open Source software dependencies.

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Run ORT

              
  uses: edulix/[email protected]
Learn more about this action in edulix/ort-action

Choose a version

Execute ORT with a Github Action

Marketplace Release

This action allows you to run ORT. The OSS Review Toolkit (ORT) aims to assist with the tasks that commonly need to be performed in the context of license compliance checks, especially for (but not limited to) Free and Open Source Software dependencies.

THIS IS AN EXPERIMENTAL ACTION

Configuration

You can specify the configuration in a .spdx-builder.yml in the root of your project. See instructions in philips-software/spdx-builder.

Environment

This action requires a java environment. (See example)

Description

Get SPDX license overview

Inputs

parameter description required default
ort-version edulix/ort docker hub tag to use. false latest
analyze Set to false to disable the execution of the ORT analyze ORT Action. false true
evaluate Set to false to disable the execution of the ORT evaluate ORT Action. false true
report Set to false to disable the execution of the ORT report ORT Action. false true
package-curations-dir Specifies path relative to the project directory for the curations directory. Used in analyze and evaluate actions. It's the --package-curations-dir option for ORT. false
rules-file Specifies path relative to the project directory for the rules of the evaluate action. It's the --rules-file option for ORT. false
license-classifications-file Specifies path relative to the project directory for the license classifications file of the evaluate action. It's the --license-classifications-file option for ORT. false
license-classifications-file List of reporters to run. false Excel,StaticHtml,WebApp
analyze-extra-args List of extra arguments for the analyze action. false
evaluate-extra-args List of extra arguments for the evaluate action. false
report-extra-args List of extra arguments for the report action. false

Outputs

parameter description
analyzer-result output file for the analyze step
evaluation-result output file for the evaluate step
report-result-dir output file for the report step

Runs

This action is an composite action.

GitHub workflow

  - uses: actions/checkout@v2
  - uses: actions/setup-java@v1
    with:
      java-version: '11.0.1'

  - name: Analyze licensing 
    id: ort-action
    uses: edulix/ort-action

  - uses: actions/upload-artifact@v2
    with:
      name: licenses
      path: ${{ steps.ort-action.outputs.report-result-dir }}