{"id":20801898,"url":"https://github.com/philips-software/spdx-action","last_synced_at":"2025-12-25T02:39:03.775Z","repository":{"id":45280798,"uuid":"331884475","full_name":"philips-software/spdx-action","owner":"philips-software","description":"GitHub Action to get a license overview in SPDX format","archived":false,"fork":false,"pushed_at":"2021-12-24T16:59:30.000Z","size":161,"stargazers_count":14,"open_issues_count":2,"forks_count":4,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-03-09T00:34:12.948Z","etag":null,"topics":["license-scanning-framework","sbom","software-bill-of-materials"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/philips-software.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null}},"created_at":"2021-01-22T08:32:01.000Z","updated_at":"2023-08-30T06:42:07.000Z","dependencies_parsed_at":"2023-01-11T17:22:47.734Z","dependency_job_id":null,"html_url":"https://github.com/philips-software/spdx-action","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philips-software%2Fspdx-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philips-software%2Fspdx-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philips-software%2Fspdx-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philips-software%2Fspdx-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/philips-software","download_url":"https://codeload.github.com/philips-software/spdx-action/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243147272,"owners_count":20243745,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["license-scanning-framework","sbom","software-bill-of-materials"],"created_at":"2024-11-17T18:25:26.060Z","updated_at":"2025-12-25T02:39:03.730Z","avatar_url":"https://github.com/philips-software.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# Get SPDX license overview\n\n[![Marketplace](https://img.shields.io/badge/GitHub-Marketplace-green.svg)](https://github.com/marketplace/actions/get-spdx-license-overview) [![Release](https://img.shields.io/github/release/philips-software/spdx-action.svg)](https://github.com/philips-software/spdx-action/releases)\n\nThis action will create a SPDX license overview with ORT and SPDX-builder.\n\u003e THIS IS AN EXPERIMENTAL ACTION\n\n\u003c/div\u003e\n\n## Configuration\nYou can specify the configuration in a `.spdx-builder.yml` in the root of your project.\nSee [instructions in philips-software/spdx-builder](https://github.com/philips-software/spdx-builder#including-projects-in-the-spdx-file).\n\n## Environment\nThis action requires a java environment. (See example)\n\n\u003c!-- action-docs-description --\u003e\n## Description\n\nGet SPDX license overview\n\n\n\u003c!-- action-docs-description --\u003e\n\n\u003c!-- action-docs-inputs --\u003e\n## Inputs\n\n| parameter | description | required | default |\n| - | - | - | - |\n| project | project | `true` | spdx-builder |\n| spdx-builder-version | spdx-builder-version | `true` | v0.9.2 |\n| mode | Scan mode. Can be 'ort', 'blackduck' or 'tree' | `true` | ort |\n| scanner-url | scanner-url (license-scanner) | `false` |  |\n| bombase-url | bombase-url (in case of mode: 'tree') | `false` |  |\n| upload-url | upload-url (f.e. BOM-bar) | `false` |  |\n| ort-version | philipssoftware/ort version (in case of mode: 'ort') | `false` | 2021-11-24 |\n| ort-file | Specifies an ort-file to override ORT scanning in this action. (in case of mode: 'ort') | `false` |  |\n| tree | file with tree input (in case of mode: 'tree') | `false` |  |\n| format | format input (in case of mode: 'tree') | `false` |  |\n| blackduck-url | Blackduck url (in case of mode: 'blackduck') | `false` |  |\n| blackduck-token | Blackduck token (in case of mode: 'blackduck') | `false` |  |\n| blackduck-project | Blackduck project (in case of mode: 'blackduck') | `false` |  |\n| blackduck-version | Blackduck version (in case of mode: 'blackduck') | `false` |  |\n| optional-arguments | Optional arguments like `--tree`, `--release`, `--force` and `--custom` | `false` |  |\n| capture-stdout-file | Capture stdout in a file. When given, this will be used as the filename of the output | `false` |  |\n\n\n\n\u003c!-- action-docs-inputs --\u003e\n\n\u003c!-- action-docs-outputs --\u003e\n## Outputs\n\n| parameter | description |\n| - | - |\n| spdx-file | spdx-license file |\n| ort-file | ort-license file |\n\n\n\n\u003c!-- action-docs-outputs --\u003e\n\n\u003c!-- action-docs-runs --\u003e\n## Runs\n\nThis action is an `composite` action.\n\n\n\u003c!-- action-docs-runs --\u003e\n\n## GitHub workflow\n\nMake sure you have a proper `.spdx-builder.yml` file in your project.\n\n### `ORT` mode\n```yml\n  - uses: actions/checkout@v2\n  - uses: actions/setup-java@v1\n    with:\n      java-version: '11.0.13'\n  - name: Create spdx-file\n    id: spdx-builder\n    uses: philips-software/spdx-action@v0.9.1.1\n    with:\n      project: my-project\n      mode: ort\n  - uses: actions/upload-artifact@v2\n    with:\n      name: licenses\n      path: ${{ steps.spdx-builder.outputs.spdx-file }}\n```\n\n### `tree` mode\n```yml\n  - uses: actions/checkout@v2\n  - uses: actions/setup-java@v1\n    with:\n      java-version: '11.0.13'\n  - name: Create tree\n    run: |\n      npm list --all --production \u003e npm-dependencies.txt\n  - name: Create spdx-file\n    id: spdx-builder\n    uses: philips-software/spdx-action@v0.9.1.1\n     with:\n      project: my-project\n      mode: 'tree'\n      tree: 'npm-dependencies.txt'\n      format: 'npm'\n      bombase-url: \u003cbombase-url\u003e # Optional\n  - uses: actions/upload-artifact@v2\n    with:\n      name: licenses\n      path: ${{ steps.spdx-builder.outputs.spdx-file }}\n```\n\n### `blackduck` mode\n```yml\n  - uses: actions/checkout@v2\n  - uses: actions/setup-java@v1\n    with:\n      java-version: '11.0.13'\n  - name: Create spdx-file\n    id: spdx-builder\n    uses: philips-software/spdx-action@v0.9.1.1\n    with:\n      project: my-project\n      mode: 'blackduck'\n      blackduck-url: \u003cblackduck-url\u003e\n      blackduck-token: ${{ secrets.BLACKDUCK_TOKEN }}\n      blackduck-project: \u003cproject-name\u003e\n      blackduck-version: \u003cproject-version\u003e\n  - uses: actions/upload-artifact@v2\n    with:\n      name: licenses\n      path: ${{ steps.spdx-builder.outputs.spdx-file }}\n```\n\n## Philips Forest\n\nThis module is part of the Philips Forest.\n\n```\n                                                     ___                   _\n                                                    / __\\__  _ __ ___  ___| |_\n                                                   / _\\/ _ \\| '__/ _ \\/ __| __|\n                                                  / / | (_) | | |  __/\\__ \\ |_\n                                                  \\/   \\___/|_|  \\___||___/\\__|\n\n                                                                            CI\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphilips-software%2Fspdx-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphilips-software%2Fspdx-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphilips-software%2Fspdx-action/lists"}