Skip to main content

Module transport

Module transport 

Source
Expand description

Bounded GitHub REST transport and fixed gh process adapter. Bounded GitHub REST transport for remote build orchestration.

Every request uses an explicit repository endpoint and fixed gh api arguments. The process runner clears ambient environment state, supplies exactly one configured authentication source, caps captured output, and never returns command stderr in errors.

Structs§

ActionsPermissions
Repository-scoped GitHub Actions availability.
ArtifactDownloadTarget
Canonical download directory plus a safe ZIP basename.
ArtifactId
Non-zero GitHub artifact identifier.
ArtifactInfo
Bounded artifact metadata returned by one run.
ArtifactName
Exact generated artifact name expected from the workflow.
AuthenticatedUser
Parsed authenticated GitHub account.
BranchName
Exact Git branch name without the refs/heads/ prefix.
CommitSha
Exact lowercase 40-character Git commit identifier.
DeploymentBranchPolicy
One bounded custom deployment branch policy.
DownloadedArtifact
Completed bounded artifact download.
EnvironmentInfo
Security-relevant metadata for one exact GitHub Environment.
EnvironmentSecret
Metadata for one environment secret; secret values are never readable.
EnvironmentSecretWriteReceipt
Secret-free confirmation that gh accepted one exact Environment write.
EnvironmentSecretWriteRequest
Exact secret role and protected GitHub Environment selected for one write.
GhProcessRunner
Real fixed-argv GitHub CLI process runner.
GhRequest
Fully planned, non-secret gh api request.
GithubTransport
GitHub.com transport over an injectable gh api runner.
GithubWorkflowDispatchHttpRequest
Bounded direct HTTPS request for one workflow dispatch.
GithubWorkflowDispatchHttpResponse
Bounded HTTP result. Debug output never includes response bytes or URLs.
PollPolicy
Bounded polling policy for one known run.
Repository
Explicit GitHub owner and repository name.
RepositoryInfo
Parsed repository metadata used before dispatch.
RunHandle
Exact identity selected during run lookup.
RunId
Non-zero GitHub run identifier.
RunSnapshot
One locally identity-checked run observation.
TemporaryGitRef
A branch proven to be below the configured temporary namespace.
ThreadPollSleeper
Standard thread-based polling sleeper.
TransportLimits
Bounded metadata, pagination, and artifact-download policy.
WorkflowDispatchReceipt
Secret-free receipt binding one positive run ID to every expected run identity field.
WorkflowDispatchRequest
Validated public inputs for one no-secret workflow dispatch.
WorkflowId
Non-zero GitHub workflow identifier.
WorkflowRegistration
One active workflow registration bound to its exact repository path.

Enums§

ApiMethod
HTTP method used by a planned gh api call.
AuthenticatedPrincipal
Validated GitHub API credential principal without overstating identity.
GhAuthentication
Explicit GitHub CLI authentication source.
GhExecutionError
Redacted execution failure from a gh runner.
GithubWorkflowDispatchHttpError
Redacted direct-HTTPS dispatch failure.
RunConclusion
Terminal GitHub Actions run conclusion.
RunEvent
Supported workflow event used for an exact run lookup.
RunStatus
Current GitHub Actions run state.
TokenEnvironmentVariable
Exact environment variable accepted as a GitHub token source.
TransportConfigError
Validation failure for a GitHub identifier or local policy value.
TransportError
Redacted transport or response-validation failure.

Constants§

MAX_ENVIRONMENT_SECRET_BYTES
Maximum value accepted by GitHub Actions for one Environment secret.

Traits§

GhRunner
Injectable executor for planned GitHub API requests.
GhSecretRunner
Injectable executor for one fixed-argv Environment-secret write.
GithubWorkflowDispatchHttpClient
Injectable no-auto-redirect HTTPS adapter for workflow dispatch.
GithubWorkflowDispatchHttpClientFactory
Lazy factory detached from the provider’s metadata-transport lock.
PollSleeper
Sleeper injection used to test bounded polling without wall-clock delay.