{"id":20841189,"url":"https://github.com/zephyrproject-rtos/action_scancode","last_synced_at":"2025-07-29T15:39:58.296Z","repository":{"id":42656222,"uuid":"232410730","full_name":"zephyrproject-rtos/action_scancode","owner":"zephyrproject-rtos","description":null,"archived":false,"fork":false,"pushed_at":"2023-11-09T22:24:10.000Z","size":10,"stargazers_count":2,"open_issues_count":2,"forks_count":9,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-07-23T22:28:23.902Z","etag":null,"topics":["actions","ci"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zephyrproject-rtos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-07T20:25:29.000Z","updated_at":"2023-07-11T23:13:07.000Z","dependencies_parsed_at":"2024-06-19T17:35:36.848Z","dependency_job_id":"dcffbf39-36ad-4c75-87af-3a54c28ad526","html_url":"https://github.com/zephyrproject-rtos/action_scancode","commit_stats":{"total_commits":10,"total_committers":4,"mean_commits":2.5,"dds":"0.30000000000000004","last_synced_commit":"23ef91ce31cd4b954366a7b71eea47520da9b380"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/zephyrproject-rtos/action_scancode","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zephyrproject-rtos%2Faction_scancode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zephyrproject-rtos%2Faction_scancode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zephyrproject-rtos%2Faction_scancode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zephyrproject-rtos%2Faction_scancode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zephyrproject-rtos","download_url":"https://codeload.github.com/zephyrproject-rtos/action_scancode/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zephyrproject-rtos%2Faction_scancode/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267709999,"owners_count":24131933,"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","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["actions","ci"],"created_at":"2024-11-18T01:19:07.578Z","updated_at":"2025-07-29T15:39:58.258Z","avatar_url":"https://github.com/zephyrproject-rtos.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# License Scanning Action\n\nA Github action to scan code for license violations based on a configuration file per repository.\n\nThis actions uses a dedicated docker image available from:\n\nhttps://github.com/zephyrproject-rtos/docker_scancode\n\n## Example workflow\n\n```\n\nname: Scancode\n\non: [pull_request]\n\njobs:\n  scancode_job:\n    runs-on: ubuntu-latest\n    name: Scan code for licenses\n    steps:\n    - uses: actions/checkout@v1\n    - name: Scan the code\n      id: scancode\n      uses: zephyrproject-rtos/action_scancode@v1\n      with:\n        directory-to-scan: 'scan/'\n    - name: Artifact Upload\n      uses: actions/upload-artifact@v1\n      with:\n        name: scancode\n        path: ./artifacts\n\n    - name: Verify\n      run: |\n        test ! -s ./artifacts/report.txt || (cat ./artifacts/report.txt \u0026\u0026 exit 1 )\n\n```\n\nThe above example checks out the code and runs scancode on all new files being\nadded by the pull request. New files are copied into the `scan/` directory to\navoid scanning of existing files in the repository.\n\nOnce scanning is complete, resulting files are uploaded as artifacts and\navailable for further inspection.\n\nThe scanner generates a report that can be displayed to show the violations.\nDepending on your setup, you can either display it as part of the overall\naction log or you can upload it or put it in a comment in the pull-request.\n\n\n\n## Configuration\n\nThe action expects a configuration file under `.github/` named `license_config.yml`. This file is used to filter the scanning results and identify violations based on whitelisted licenses and license categories.\n\n```\nlicense:\n  main: apache-2.0\n  category: Permissive\nexclude:\n  extensions:\n    - yml\n    - yaml\n    - html\n    - rst\n    - conf\n    - cfg\n  langs:\n    - HTML\n ```\n \n \nThe `license` section sets the main license for the repository and its category. Files licensed under the same category would be allowed in this case.\n\nThe `exclude` section is used to tell the scanner which extensions and content types to ignore when looking for license/copyright boilerplate.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzephyrproject-rtos%2Faction_scancode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzephyrproject-rtos%2Faction_scancode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzephyrproject-rtos%2Faction_scancode/lists"}