{"id":16962792,"url":"https://github.com/dafnik/generate-license-report","last_synced_at":"2025-08-13T05:04:23.252Z","repository":{"id":168809615,"uuid":"644608658","full_name":"Dafnik/generate-license-report","owner":"Dafnik","description":"An node packages license report generation action.","archived":false,"fork":false,"pushed_at":"2025-05-01T12:24:54.000Z","size":1545,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-11T04:48:58.334Z","etag":null,"topics":["action","actions","ci","license","license-management","licenses","report"],"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/Dafnik.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"Dafnik","liberapay":"Dafnik"}},"created_at":"2023-05-23T22:08:52.000Z","updated_at":"2025-05-01T12:24:57.000Z","dependencies_parsed_at":"2024-02-01T13:29:44.577Z","dependency_job_id":"b1756829-2340-49bb-96cd-6388fd82c75e","html_url":"https://github.com/Dafnik/generate-license-report","commit_stats":null,"previous_names":["dafnik/generate-license-report"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/Dafnik/generate-license-report","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dafnik%2Fgenerate-license-report","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dafnik%2Fgenerate-license-report/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dafnik%2Fgenerate-license-report/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dafnik%2Fgenerate-license-report/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Dafnik","download_url":"https://codeload.github.com/Dafnik/generate-license-report/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dafnik%2Fgenerate-license-report/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270183606,"owners_count":24541341,"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-08-13T02:00:09.904Z","response_time":66,"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":["action","actions","ci","license","license-management","licenses","report"],"created_at":"2024-10-13T23:07:52.418Z","updated_at":"2025-08-13T05:04:23.155Z","avatar_url":"https://github.com/Dafnik.png","language":null,"funding_links":["https://github.com/sponsors/Dafnik","https://liberapay.com/Dafnik"],"categories":[],"sub_categories":[],"readme":"# generate-license-report\n\nAn node packages license report generation action.\n\n## Usage\n\n```yml\nname: Generate license report\non:\n  workflow_dispatch:\n  schedule:\n    - cron: '0 4 */30 * *' # At 04:00 on every 30ts day-of-month.\n\njobs:\n  generate-license-pr:\n    runs-on: ubuntu-latest\n    steps:\n      - name: checkout your repository using git\n        uses: actions/checkout@v4\n\n      # generate-license-report needs node_modules installed to fully function\n      # caching is not setup as this action should not run this often\n      # NPM\n      #- run: npm ci --ignore-scripts\n      # PNPM\n      #- uses: pnpm/action-setup@v2\n      #  with:\n      #    version: 7\n      #- run: pnpm install --frozen-lockfile --ignore-scripts\n      # yarn\n      #- run: yarn install --frozen-lockfile --ignore-scripts\n      - name: generate license report\n        id: license-report\n        uses: dafnik/generate-license-report@v2\n        #with:\n        #  package-json-path: 'package.json'\n        #  license-report-path: 'licenses.json'\n        #  output-format: 'json'\n\n      - name: create new pull request if needed\n        if: steps.license-report.outputs.has-no-changes != 'true'\n        uses: peter-evans/create-pull-request@v5\n        with:\n          title: Generated new licenses report\n          branch-suffix: timestamp\n          commit-message: 'chore: generate new license report'\n          body: ${{ steps.license-report.outputs.diff }}\n```\n\n### Inputs\n\n\u003c!-- prettier-ignore-start --\u003e\n| Inputs                          | Default value   | Description                                                                                                                                                                                                                                  |\n|---------------------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `package-json-path`             | `package.json`  | Path to your `package.json`                                                                                                                                                                                                                  |\n| `license-report-path`           | `licenses.json` | Path to your already existing license report file for comparison                                                                                                                                                                             |\n| `output-format`                 | `json`          | Output format of `license-report`. [Supported formats](#supported-output-formats) \u003cbr/\u003e If you update the output format you also have to update the `license-report-path`. \u003cbr/\u003e For example: `licenses.md`, `licenses.html`, `licenses.csv` |\n| `prettier`                      | `true`          | Run prettier on license report                                                                                                                                                                                                               |\n| `custom-license-report-command` | `false`         | Execute the `license-report` command located in **your** `package.json`                                                                                                                                                                      |\n\u003c!-- prettier-ignore-end --\u003e\n\nFurthermore, see [action.yml](action.yml)\n\n#### Supported output formats\n\n- table\n- csv\n- json\n- markdown\n\n### Outputs\n\n\u003c!-- prettier-ignore-start --\u003e\n| Outputs          | Description                                                                         |\n|------------------|-------------------------------------------------------------------------------------|\n| `has-no-changes` | Flag to indicate if there are no changes in the licenses file.                      |\n| `diff`           | Differences between old and new license report in `markdown`.                       |\n| `licenses`       | License report as `string` in your chosen `output-format`. \u003cbr\u003e Is always returned. |\n\u003c!-- prettier-ignore-end --\u003e\n\n## Building\n\n```bash\npnpm build\n```\n\n## Testing\n\nRun the project in this repository:\n\n```bash\npnpm dev\n```\n\nRun the test workflow:\n\n```bash\nact -j test\n```\n\nLocal testing is done with [act][act]\n\n## Release instructions\n\nIn order to release a new version of this action:\n\n1. Locate the semantic version of the [upcoming release][release-list] (a draft is maintained by the [`draft-release` workflow][draft-release]).\n\n2. Publish the draft release from the `main` branch with semantic version as the tag name, _with_ the checkbox to publish to the GitHub Marketplace checked. :ballot_box_with_check:\n\n3. After publishing the release, the [`release` workflow][release] will automatically run to create/update the corresponding the major version tag such as `v0`.\n\n   ⚠️ Environment approval is required. Check the [Release workflow run list][release-workflow-runs].\n\n## License\n\nThe scripts and documentation in this project are released under the [MIT License](LICENSE).\n\n\u003c!-- references --\u003e\n\n[act]: https://github.com/nektos/act\n[release-list]: https://github.com/dafnik/generate-license-report/releases\n[draft-release]: .github/workflows/draft-release.yml\n[release]: .github/workflows/release.yml\n[release-workflow-runs]: https://github.com/dafnik/generate-license-report/actions/workflows/release.yml\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdafnik%2Fgenerate-license-report","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdafnik%2Fgenerate-license-report","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdafnik%2Fgenerate-license-report/lists"}