{"id":20806344,"url":"https://github.com/nodesource/ncm-report-github-action","last_synced_at":"2026-04-19T23:32:01.044Z","repository":{"id":82084509,"uuid":"255396102","full_name":"nodesource/ncm-report-github-action","owner":"nodesource","description":"GitHub Action for NCM","archived":false,"fork":false,"pushed_at":"2023-05-04T16:32:29.000Z","size":30,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-27T09:26:10.393Z","etag":null,"topics":["annotations","ncm","vulnerabilities","workflow"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nodesource.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-04-13T17:27:14.000Z","updated_at":"2024-03-12T12:46:02.000Z","dependencies_parsed_at":null,"dependency_job_id":"81585ad5-3334-49ef-a2dc-43b3066716e0","html_url":"https://github.com/nodesource/ncm-report-github-action","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/nodesource/ncm-report-github-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodesource%2Fncm-report-github-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodesource%2Fncm-report-github-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodesource%2Fncm-report-github-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodesource%2Fncm-report-github-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nodesource","download_url":"https://codeload.github.com/nodesource/ncm-report-github-action/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodesource%2Fncm-report-github-action/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32026619,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T20:23:30.271Z","status":"online","status_checked_at":"2026-04-19T02:00:07.110Z","response_time":55,"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":["annotations","ncm","vulnerabilities","workflow"],"created_at":"2024-11-17T19:19:26.360Z","updated_at":"2026-04-19T23:32:01.039Z","avatar_url":"https://github.com/nodesource.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NCM Report Github Action\n\n![NodeSource Certification process](https://github.com/nodesource/ncm-report-github-action/workflows/NodeSource%20Certification%20process/badge.svg?event=push)\n\nThis action generates and prints a project-wide report of directory risk and\nquality of installed or specified packages.\n\n## Inputs\n\n### `token`\n\n_Default_: `\u003cempty\u003e`\n\n**Required** Learn more about obtaining NodeSource service tokens and\nconfiguring permissions [here](https://docs.nodesource.com/ncm_v2/docs#ci-setup).\nWe recommend you using repository [Secrets](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) to store this value and use it in the workflow.\n\n### `long`\n\n_Default_: `no`\n\n**Optional** Set `yes` if you want the report display a list of all modules.\n\n### `compliance`\n\n_Default_: `no`\n\n**Optional** Set `yes` if you want the report only display non-compliant\npackages.\n\n### `security`\n\n_Default_: `no`\n\n**Optional** Set `yes` if you want the report only display packages with\nvulnerabilities.\n\n### `github_token`\n\n_Default_: `${{ secrets.GITHUB_TOKEN }}`\n\n**Required** Set to pass the internal GitHub Token for NCM to update the check\nand make annotations. Use the default value (`${{ secrets.GITHUB_TOKEN }}`), you\ndon't need to create any token in Secrets for this, GitHub automatically creates\nand sets this in the Action context.\n\n### `github_job_name`\n\n_Default_: `\u003cempty\u003e`\n\n**Required** You need to set the same name you set to your job. If not,\nannotations will not be able to be included in your PR or RunCheck.\n\n## Example usage\n\nThis action can be used in the following scenarios:\n\n* Default report:\n\n```\nuses: nodesource/ncm-report-github-action@master\nwith:\n  token: ${{ secrets.NCM_TOKEN }}\n  github_token: ${{ secrets.GITHUB_TOKEN }}\n  github_job_name: N|S -\u003e NCM Pipeline\n```\n\n* Long version of the report:\n\n```\nuses: nodesource/ncm-report-github-action@master\nwith:\n  token: ${{ secrets.NCM_TOKEN }}\n  long: 'yes'\n  github_token: ${{ secrets.GITHUB_TOKEN }}\n  github_job_name: N|S -\u003e NCM Pipeline\n```\n\n* Report with compliance only informaiton:\n\n```\nuses: nodesource/ncm-report-github-action@master\nwith:\n  token: ${{ secrets.NCM_TOKEN }}\n  compliance: 'yes'\n  github_token: ${{ secrets.GITHUB_TOKEN }}\n  github_job_name: N|S -\u003e NCM Pipeline\n```\n\n* Report with package vulnerabilities only informaiton:\n\n```\nuses: nodesource/ncm-report-github-action@master\nwith:\n  token: ${{ secrets.NCM_TOKEN }}\n  compliance: 'yes'\n  github_token: ${{ secrets.GITHUB_TOKEN }}\n  github_job_name: N|S -\u003e NCM Pipeline\n```\n\nTo generate the report, `NCM` needs to get your `node_modules` folder to analyze\nand compare data, so, you might need to use more actions to get your code inside\nthe workflow and the dependencies installed. We recommend you using:\n\n```\n- uses: actions/checkout@v2\n- run: npm install\n```\n\nFeel free to check the workflow in `github/workflows/ncm-report.yml` for\nreference and real world usage example.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodesource%2Fncm-report-github-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnodesource%2Fncm-report-github-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodesource%2Fncm-report-github-action/lists"}