{"id":19787168,"url":"https://github.com/guidepup/setup-action","last_synced_at":"2026-01-25T23:20:22.644Z","repository":{"id":59676749,"uuid":"454549928","full_name":"guidepup/setup-action","owner":"guidepup","description":"GitHub Action to setup your CI for screen reader test automation. ","archived":false,"fork":false,"pushed_at":"2025-11-16T18:40:31.000Z","size":22737,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-16T20:23:15.760Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://guidepup.dev","language":"JavaScript","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/guidepup.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["cmorten"]}},"created_at":"2022-02-01T21:01:47.000Z","updated_at":"2025-11-16T18:39:43.000Z","dependencies_parsed_at":"2023-11-19T23:26:20.435Z","dependency_job_id":"bf621bfc-509d-4da5-9bab-71568fa7f7c2","html_url":"https://github.com/guidepup/setup-action","commit_stats":{"total_commits":53,"total_committers":5,"mean_commits":10.6,"dds":"0.39622641509433965","last_synced_commit":"46a7b0965a4148d5e4752b098930709703b95dd3"},"previous_names":[],"tags_count":45,"template":false,"template_full_name":null,"purl":"pkg:github/guidepup/setup-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guidepup%2Fsetup-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guidepup%2Fsetup-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guidepup%2Fsetup-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guidepup%2Fsetup-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/guidepup","download_url":"https://codeload.github.com/guidepup/setup-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guidepup%2Fsetup-action/sbom","scorecard":{"id":448409,"data":{"date":"2025-08-11","repo":{"name":"github.com/guidepup/setup-action","commit":"20ba7f1e72169d8ff5638c69376f36420dcda4cd"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.6,"checks":[{"name":"Code-Review","score":0,"reason":"Found 2/29 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":4,"reason":"5 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 4","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"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":"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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql-analysis.yml:28","Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql-analysis.yml:29","Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1","Info: no jobLevel write permissions found"],"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":"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":"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":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: node_modules/ffmpeg-static/ffmpeg:1"],"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":7,"reason":"SAST tool detected but not run on all commits","details":["Info: SAST configuration detected: CodeQL","Warn: 1 commits out of 5 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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/guidepup/setup-action/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/guidepup/setup-action/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/guidepup/setup-action/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:70: update your workflow using https://app.stepsecurity.io/secureworkflow/guidepup/setup-action/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/guidepup/setup-action/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/guidepup/setup-action/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/guidepup/setup-action/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/guidepup/setup-action/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/guidepup/setup-action/test.yml/main?enable=pin","Info:   0 out of   9 GitHub-owned GitHubAction 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":"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"}}]},"last_synced_at":"2025-08-19T07:30:41.300Z","repository_id":59676749,"created_at":"2025-08-19T07:30:41.300Z","updated_at":"2025-08-19T07:30:41.300Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28761814,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T23:06:19.311Z","status":"ssl_error","status_checked_at":"2026-01-25T23:03:50.555Z","response_time":113,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2024-11-12T06:21:26.916Z","updated_at":"2026-01-25T23:20:22.639Z","avatar_url":"https://github.com/guidepup.png","language":"JavaScript","funding_links":["https://github.com/sponsors/cmorten"],"categories":[],"sub_categories":[],"readme":"# Guidepup Setup Action\n\n\u003ca href=\"https://github.com/guidepup/setup-action/blob/main/LICENSE\"\u003e\u003cimg alt=\"Guidepup Setup Action uses the MIT license\" src=\"https://img.shields.io/github/license/guidepup/setup-action\" /\u003e\u003c/a\u003e\n\n## [Documentation](https://www.guidepup.dev/docs/guides/automated-environment-setup)\n\n[![MacOS Monetary Support](https://img.shields.io/badge/macos-Monetary-blue.svg?logo=apple)](https://apps.apple.com/us/app/macos-monterey/id1576738294)\n[![MacOS Ventura Support](https://img.shields.io/badge/macos-Ventura-blue.svg?logo=apple)](https://apps.apple.com/us/app/macos-ventura/id1638787999)\n[![MacOS Sonoma Support](https://img.shields.io/badge/macos-Somona-blue.svg?logo=apple)](https://apps.apple.com/us/app/macos-sonoma/id6450717509)\n[![MacOS Sequoia Not Supported](https://img.shields.io/badge/macos-Somona-red.svg?logo=apple)](https://github.com/guidepup/setup/issues/40)\n[![MacOS Tahoe Not Supported](https://img.shields.io/badge/macos-Tahoe-red.svg?logo=apple)](https://github.com/guidepup/setup/issues/48)\n[![Windows 10 Support](https://img.shields.io/badge/windows-10-blue.svg?logo=windows10)](https://www.microsoft.com/en-gb/software-download/windows10ISO)\n[![Windows Server 2019 Support](https://img.shields.io/badge/windows_server-2019-blue.svg?logo=windows)](https://www.microsoft.com/en-us/evalcenter/evaluate-windows-server-2019)\n[![Windows Server 2022 Support](https://img.shields.io/badge/windows_server-2022-blue.svg?logo=windows)](https://www.microsoft.com/en-us/evalcenter/evaluate-windows-server-2022)\n[![Windows Server 2025 Support](https://img.shields.io/badge/windows_server-2025-blue.svg?logo=windows)](https://www.microsoft.com/en-us/evalcenter/evaluate-windows-server-2025)\n\nGitHub Action to set up your environment for screen reader automation.\n\nIt enables automation for \u003ca href=\"https://www.guidepup.dev/docs/api/class-voiceover\"\u003e\u003cb\u003eVoiceOver on MacOS\u003c/b\u003e\u003c/a\u003e and \u003ca href=\"https://www.guidepup.dev/docs/api/class-nvda\"\u003e\u003cb\u003eNVDA on Windows\u003c/b\u003e\u003c/a\u003e using the [`@guidepup/setup`](https://github.com/guidepup/setup/) package.\n\n## Usage\n\nJust add this step to your workflow(s) to enable steps that use screen reader automation in GitHub CI:\n\n```yaml\n- name: Setup Environment\n  uses: guidepup/setup-action\n```\n\n### MacOS\n\n#### Recording\n\nIf you are encountering errors in CI for MacOS you can pass a `record` option which will output a screen-recording of the setup to a `./recordings/` directory:\n\n```yaml\n- name: Setup Environment\n  uses: guidepup/setup-action\n  with:\n    record: true\n```\n\nThere are also options to change the screen resolution:\n\n```yaml\n- name: Setup Environment\n  uses: guidepup/setup-action\n  with:\n    resolutionWidth: \"1920\"\n    resolutionHeight: \"1080\"\n```\n\n#### Ignore TCC.db Updates\n\nIf updating the TCC.db is not possible (due to SIP) or required you can skip the database update step by passing a `ignoreTccDb` option:\n\n```yaml\n- name: Setup Environment\n  uses: guidepup/setup-action\n  with:\n    ignoreTccDb: true\n```\n\n\u003e [!NOTE]\n\u003e If the necessary permissions have not been granted by other means, using this flag may result in your environment not being set up for reliable screen reader automation.\n\n### Windows\n\n#### NVDA Installation\n\nWhen running on windows a portable NVDA instance compatible with Guidepup will be installed to a temporary directory by default. The location of this installation directory is stored in the Windows registry under the key `HKCU\\Software\\Guidepup\\Nvda`.\n\nIf you want to specify the directory that NVDA is installed to you can pass a `nvdaInstallDir` option:\n\n```yaml\n- name: Setup Environment\n  uses: guidepup/setup-action\n  with:\n    nvdaInstallDir: \u003cNVDA_INSTALLATION_DIRECTORY\u003e\n```\n\n## Supports\n\n- [Guidepup](https://github.com/guidepup/guidepup/)\n- [Auto-VO](https://www.npmjs.com/package/@accesslint/auto-vo)\n- [VoiceOver.js](https://www.npmjs.com/package/@accesslint/voiceover)\n- [web-test-runner-voiceover](https://www.npmjs.com/package/web-test-runner-voiceover)\n\nand more!\n\n## Powerful Tooling\n\nCheck out some of the other Guidepup modules:\n\n- [`@guidepup/guidepup`](https://github.com/guidepup/guidepup/) - Reliable automation for your screen reader a11y workflows through JavaScript supporting VoiceOver and NVDA.\n- [`@guidepup/playwright`](https://github.com/guidepup/guidepup-playwright/) - Seamless integration of Guidepup with Playwright.\n- [`@guidepup/virtual-screen-reader`](https://github.com/guidepup/virtual-screen-reader/) - Reliable unit testing for your screen reader a11y workflows.\n- [`@guidepup/jest`](https://github.com/guidepup/jest/) - Jest matchers for reliable unit testing of your screen reader a11y workflows.\n\n## Resources\n\n- [Documentation](https://www.guidepup.dev/docs/guides/automated-environment-setup)\n- [Changelog](https://github.com/guidepup/setup-action/releases)\n- [MIT License](https://github.com/guidepup/setup-action/blob/main/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguidepup%2Fsetup-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguidepup%2Fsetup-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguidepup%2Fsetup-action/lists"}