@playrunner/github
v0.2.3
Published
GitHub integration package for Playrunner.
Readme
@playrunner/github
GitHub authentication and repository access for Playrunner workflows.
Install
npm install @playrunner/githubAdd the package as a direct production dependency of the Playrunner frontend and API. Playwright installations also use this package for repository authentication.
Package surfaces
@playrunner/githubexports the GitHub integration, icon, and settings UI.@playrunner/github/apiexports token exchange and refresh API routes.@playrunner/github/e2eexports the package-owned E2E contribution.@playrunner/github/assets/github.svgexports the package-owned icon.
import githubIntegration, { GithubSettingsModal } from '@playrunner/github';
import githubApiContribution from '@playrunner/github/api';Testing
Run the package checks from the repository root:
npm run format:check --prefix packages/github
npm run lint --prefix packages/github
npm run typecheck --prefix packages/github
npm run test:e2e:mock -- --grep @githubThe E2E scenario validates the GitHub OAuth setup form. It runs in deterministic mock mode through the shared Playrunner browser harness, which uses the real frontend, API, authentication, and dedicated E2E database. No GitHub credentials or live provider requests are required.
Documentation
See the GitHub integration documentation for GitHub App setup, exports, and Playrunner build integration.
License
Licensed under the Playrunner Sustainable Use License.
