@paraharness/github
Variables
| Variable | Description |
|---|---|
| defaultGithubHttpTransport | Default @octokit/rest-backed HTTP transport targeting https://api.github.com. |
| github | Frozen @paraharness/github DSL namespace singleton (github.issues, github.webhookStream, github.createOrUpdatePr). |
| githubExecutors | Default frozen RuntimeExecutorRegistrySlice for @paraharness/github. |
Functions
| Function | Description |
|---|---|
| createGithubCreateOrUpdatePrBuilder | Creates an immutable fluent GithubCreateOrUpdatePrBuilder (github.createOrUpdatePr). |
| createGithubExecutors | Creates a RuntimeExecutorRegistrySlice registering all @paraharness/github runtime executors. |
| createGithubIssuesBuilder | Compiles a passive GithubIssuesTrackerNode from GithubIssuesOptions (github.issues). |
| createGithubWebhookStreamBuilder | Compiles a passive GithubWebhookStreamNode from GithubWebhookStreamOptions (github.webhookStream). |
| executeGithubCreateOrUpdatePrStep | Stateless domain step executor for GithubCreateOrUpdatePrNode (github:create-or-update-pr). |
Classes
| Class | Description |
|---|---|
| GithubIssuesTrackerAdapter | Runtime TrackerAdapter implementation for GithubIssuesTrackerNode (github:issues). |
| GithubWebhookStreamSource | Runtime StreamSource implementation for GithubWebhookStreamNode (github:webhook-stream). |
Interfaces
| Interface | Description |
|---|---|
| GithubCreateOrUpdatePrBuilder | Fluent builder for a GithubCreateOrUpdatePrNode domain step (github.createOrUpdatePr). |
| GithubCreateOrUpdatePrNode | Passive AST node creating or updating a GitHub pull request (github.createOrUpdatePr). |
| GithubCreateOrUpdatePrOptions | Configuration options for the GitHub pull-request step builder (github.createOrUpdatePr). |
| GithubHttpRequestOptions | Request options passed to GithubHttpTransport.request(...). |
| GithubHttpTransport | Pluggable HTTP transport abstraction for GitHub REST API requests. |
| GithubIssueRecord | Normalized GitHub issue record emitted by GithubIssuesTrackerAdapter.poll(). |
| GithubIssuesOptions | Configuration options for the GitHub Issues tracker builder (github.issues). |
| GithubIssuesTrackerNode | Passive AST node configuring a GitHub Issues tracker adapter (github.issues). |
| GithubNamespace | Public DSL builder namespace for @paraharness/github (github.*). |
| GithubWebhookBranchRef | Branch reference descriptor nested inside a GitHub pull request webhook payload. |
| GithubWebhookEvent | Default typed GitHub webhook delivery event payload emitted by github.webhookStream(...). |
| GithubWebhookPullRequestPayload | Pull request payload nested inside a GitHub pull_request webhook event. |
| GithubWebhookRepositoryPayload | Repository metadata nested inside a GitHub webhook delivery payload. |
| GithubWebhookStreamNode | Passive AST node configuring a GitHub webhook event stream source (github.webhookStream). |
| GithubWebhookStreamOptions | Configuration options for the GitHub webhook event stream builder (github.webhookStream). |