{"id":15680684,"url":"https://github.com/manics/action-binderbadge","last_synced_at":"2025-08-22T10:16:44.025Z","repository":{"id":37076558,"uuid":"292674587","full_name":"manics/action-binderbadge","owner":"manics","description":"GitHub action to comment on pull requests with a link to launch the PR on https://mybinder.org","archived":false,"fork":false,"pushed_at":"2024-02-29T22:46:24.000Z","size":3155,"stargazers_count":11,"open_issues_count":6,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-23T18:34:46.418Z","etag":null,"topics":["binderhub","github-action","javascript-action","mybinder"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/manics.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-09-03T20:36:06.000Z","updated_at":"2022-03-24T02:35:15.000Z","dependencies_parsed_at":"2024-10-05T19:30:28.354Z","dependency_job_id":"dfa0b28b-9f63-4424-9da0-c9224cba40c2","html_url":"https://github.com/manics/action-binderbadge","commit_stats":{"total_commits":572,"total_committers":4,"mean_commits":143.0,"dds":"0.11888111888111885","last_synced_commit":"d1789427cb95ed9f514aec821ccc9e3c724c8b4b"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":"actions/typescript-action","purl":"pkg:github/manics/action-binderbadge","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manics%2Faction-binderbadge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manics%2Faction-binderbadge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manics%2Faction-binderbadge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manics%2Faction-binderbadge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/manics","download_url":"https://codeload.github.com/manics/action-binderbadge/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manics%2Faction-binderbadge/sbom","scorecard":{"id":615086,"data":{"date":"2025-08-11","repo":{"name":"github.com/manics/action-binderbadge","commit":"99560b89939071823821e105afc83aaa87927e03"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.8,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/5 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: jobLevel 'contents' permission set to 'write': .github/workflows/test-and-update.yml:13","Warn: no topLevel permission defined: .github/workflows/binder-badge.yml:1","Warn: no topLevel permission defined: .github/workflows/test-and-update.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Pinned-Dependencies","score":1,"reason":"dependency not pinned by hash detected -- score normalized to 1","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/binder-badge.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/manics/action-binderbadge/binder-badge.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-update.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/manics/action-binderbadge/test-and-update.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-update.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/manics/action-binderbadge/test-and-update.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/manics/action-binderbadge/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/manics/action-binderbadge/test.yml/main?enable=pin","Warn: containerImage not pinned by hash: .gitpod.Dockerfile:1: pin your Docker image by updating gitpod/workspace-full:latest to gitpod/workspace-full:latest@sha256:b1195dfae7ee9a12a89d195247c3e1357cc6a18360a41473dbec67525ef434e2","Warn: npmCommand not pinned by hash: .github/workflows/test-and-update.yml:23","Warn: npmCommand not pinned by hash: .github/workflows/test.yml:23","Info:   0 out of   5 GitHub-owned GitHubAction dependencies pinned","Info:   1 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of   2 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"13 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-x4c5-c7rf-jjgv","Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q","Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38","Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-9qxr-qj54-h672","Warn: Project is vulnerable to: GHSA-m4v8-wqvr-p9f7","Warn: Project is vulnerable to: GHSA-c76h-2ccp-4975","Warn: Project is vulnerable to: GHSA-cxrh-j4jr-qwg3"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-21T03:42:37.504Z","repository_id":37076558,"created_at":"2025-08-21T03:42:37.504Z","updated_at":"2025-08-21T03:42:37.504Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271620909,"owners_count":24791625,"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-22T02:00:08.480Z","response_time":65,"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":["binderhub","github-action","javascript-action","mybinder"],"created_at":"2024-10-03T16:43:54.587Z","updated_at":"2025-08-22T10:16:43.935Z","avatar_url":"https://github.com/manics.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BinderHub badge GitHub Action\n\n[![build-test](https://github.com/manics/action-binderbadge/workflows/build-test/badge.svg)](https://github.com/manics/action-binderbadge/actions)\n[![Open in Gitpod](https://img.shields.io/badge/Gitpod-open-908a85?logo=gitpod)](https://gitpod.io/#https://github.com/manics/action-binderbadge)\n\nAutomatically comment on GitHub pull requests with a link to launch the PR on https://mybinder.org or some other [Binderhub](https://github.com/jupyterhub/binderhub).\n\nIf the action has already commented on a PR and further changes are made the comment will be updated to avoid excessive notifications of new comments.\n\n## Required input parameters\n\n- `githubToken`: The GitHub token, required so this action can comment on pull requests.\n\n## Optional input parameters\n\n- `binderUrl`: Optionally specify an alternative BinderHub instead of mybinder.org.\n  The URL `\u003cbinderUrl\u003e/badge_logo.svg` must exist, and will be used as the badge for linking.\n- `query`: Optional query string to pass to the launched server, for example use `urlpath=lab` to launch JupyterLab.\n- `binderUrl`: BinderHub base URL if not using https://mybinder.org\n- `environmentRepo`: If set then the current repository is used to supply the content for [nbgitpuller](https://jupyterhub.github.io/nbgitpuller/),\n  and the environment is built using `environmentRepo`.\n  Must be in the form `\u003crepo-type\u003e/\u003crepo\u003e/\u003cversion\u003e`,\n  e.g. `gist/manics/c34db392c2bd2eb133c58c83c59358a1/HEAD`.\n  The environment repo must include nbgitpuller.\n- `urlpath`: Optional URL path to pass to the launched server, for example `lab/tree/example.ipynb` or `rstudio`\n- `updateDescription`: If `true` then append the comment to the description instead of in a new comment, default `false`\n- `persistentLink`: If `true` (default) then the commit SHA will be used and the comment will be updated on subsequent runs, if `false` the branch name will be used\n\n## Examples\n\nComment on a PR with a persistent link to launch a commit on mybinder.org, update the comment if more commits are pushed:\n\n```yaml\nname: binder-badge\non:\n  pull_request_target:\n\njobs:\n  badge:\n    runs-on: ubuntu-latest\n    permissions:\n      contents: read\n      issues: write\n      pull-requests: write\n    steps:\n      - uses: manics/action-binderbadge@main\n        with:\n          githubToken: ${{ secrets.GITHUB_TOKEN }}\n```\n\nAppend a nbgitpuller mybinder link to the pull request description and open JupyterLab.\nNote that nbgitpuller does not support persistent links using git commit, so you must set `persistentLink: false` to use the branch name.\n\n```yaml\nname: binder-badge-nbgitpuller\non:\n  pull_request_target:\n\njobs:\n  badge:\n    runs-on: ubuntu-latest\n    permissions:\n      contents: read\n      issues: write\n      pull-requests: write\n    steps:\n      - uses: manics/action-binderbadge@main\n        with:\n          githubToken: ${{ secrets.GITHUB_TOKEN }}\n          environmentRepo: gist/manics/c34db392c2bd2eb133c58c83c59358a1/HEAD\n          updateDescription: true\n          urlpath: lab\n          persistentLink: false\n```\n\n## Developer notes\n\nInstall the dependencies:\n\n```bash\n$ npm install\n```\n\nCompile Typescript, run the formatter and linter:\n\n```bash\n$ npm run build \u0026\u0026 npm run format \u0026\u0026 npm run lint\n```\n\nPackage the code for distribution (uses [ncc](https://github.com/vercel/ncc)):\n\n```bash\n$ npm run package\n```\n\nRun the tests :heavy_check_mark:\n\n```bash\n$ npm test\n```\n\nThe tests use [undici.MockClient](https://undici.nodejs.org/#/docs/api/MockClient) to mock GitHub API responses, no real requests are made so manual testing is still required.\n\nShortcut:\n\n```bash\n$ npm run all\n```\n\nActions are run from GitHub repos so the packed `dist` folder must be updated and committed.\n\nThere is a [GitHub workflow to automatically update `dist`](./.github/workflows/test-and-update.yml) on a branch.\nAlternatively you can manually update the `dist` folder and commit it:\n\n```bash\n$ npm run all\n$ git add dist\n$ git commit\n$ git push origin main\n```\n\nNote that you must use the same environment (including Node version) used in the GitHub workflow since it checks that `dist` is up to date.\nThis ensures mismatching code isn't pushed to `dist`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanics%2Faction-binderbadge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmanics%2Faction-binderbadge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanics%2Faction-binderbadge/lists"}