Expand description
GitHub repository reconciliation.
Modules§
- actions
- Desired GitHub Actions settings.
- api
- API access.
- config 🔒
- The desired GitHub repository state.
- live 🔒
- operation
- The writes a plan can contain.
- permission 🔒
- plan 🔒
- The pure comparison between the desired and the live GitHub state.
- reconcile 🔒
- GitHub reconciliation over the GitHub API.
- release 🔒
- Typed GitHub pull-request, ref, and release operations.
Structs§
- Actions
Live - The live Actions settings. A group is missing when it was not read or when GitHub reports its endpoint as unavailable.
- Autolink
- An autolink reference.
- Autolinks
- Desired autolink references of a repository.
- Branch
Policy - A name pattern that may deploy to an environment.
- Bypass
Actor - An actor that may bypass a ruleset.
- Bypass
Options - Settings for delegated bypass of push protection.
- Client
- A typed GitHub backend over an injected API implementation.
- Code
Scanning - Desired code scanning default setup.
- Code
Scanning Rule - The code scanning rule of a ruleset.
- Code
Scanning Tool - A code scanning tool whose results must pass.
- Config
- A configuration document that describes one GitHub repository.
- Deployment
Branch Policy - Which branches may deploy to an environment.
- Deployments
Rule - The required deployments rule of a ruleset.
- Dismissal
Actor - An actor that may dismiss pull request reviews.
- Dismissal
Restriction - Who may dismiss pull request reviews.
- Empty
Environment Name - An environment name was the empty string.
- Empty
KeyPrefix - An autolink key prefix was the empty string.
- Empty
Ruleset Name - A ruleset name was the empty string.
- Empty
Webhook Url - A webhook delivery URL was the empty string.
- Environment
- A deployment environment.
- Environment
Name - The name of a deployment environment, which is never empty.
- Environment
Reviewer - A user or team that must approve deployments.
- Environments
- Desired deployment environments of a repository.
- KeyPrefix
- The prefix that triggers an autolink, which is never empty.
- Live
- The GitHub state that planning compares with the configuration.
- Merge
Queue Rule - The merge queue rule of a ruleset.
- Pages
- Desired Pages site of a repository.
- Pattern
Rule - A rule that requires commit or ref metadata to match a pattern.
- Pull
Request Rule - The pull request rule of a ruleset.
- Release
- GitHub release and pull-request operations for the release CLI.
- Repository
- Desired settings for a repository.
- Required
Check - A required status check.
- Reviewer
- A reviewer of push protection bypass requests.
- Role
Name - The name of a custom repository role, which is never empty.
- Rules
- The rules of a ruleset. A
falseswitch and anullrule are absent. - Ruleset
- A GitHub branch or tag ruleset, without its name.
- Ruleset
Name - The name of a ruleset, which is never empty.
- Rulesets
- Desired rulesets of a repository.
- Security
- Desired security settings of a repository.
- Source
- The branch and folder a legacy site publishes.
- Status
Checks Rule - The required status checks rule of a ruleset.
- Unknown
Target - A configuration declared a ruleset target other than
branchortag. - Update
Rule - The update rule of a ruleset.
- Variables
- Desired Actions variables of a repository.
- Webhook
- A repository webhook. The delivery URL is its key.
- Webhook
Url - The delivery URL of a webhook, which is never empty.
- Webhooks
- Desired webhooks of a repository.
- Workflow
Ref - A workflow that must pass.
- Workflows
Rule - The required workflows rule of a ruleset.
Enums§
- Actor
Type - The kind of actor that may bypass a ruleset.
- Alerts
Threshold - The alert severity at which code scanning blocks a change.
- Branch
Policy Type - Whether a branch policy matches branches or tags.
- Build
Type - How a Pages site is built.
- Bypass
Mode - When a bypass actor may skip the ruleset.
- Config
Error - A configuration value that decodes but GitHub would refuse.
- Dismissal
Actor Type - The kind of actor that may dismiss pull request reviews.
- Enforcement
- Whether a ruleset blocks, only reports, or does nothing.
- Environment
Reviewer Type - The kind of account that reviews deployments.
- Grouping
Strategy - Which entries must pass their checks in a merge queue.
- Language
- A language code scanning can analyze.
- Merge
Commit Message - The message of a merge commit.
- Merge
Commit Title - The title of a merge commit.
- Merge
Method - A way to merge a pull request.
- Pattern
Operator - How a pattern rule matches its text.
- Permission
- A repository permission GitHub can grant.
- Permission
Error - A permission that
Permissioncannot represent. - Property
Value - The value of one custom property on a repository.
- Property
Value Error - A property value that
PropertyValuecannot represent. - Pull
Request Creation Policy - Who can open pull requests.
- Query
Suite - The set of queries code scanning runs.
- Queue
Merge Method - How a merge queue merges a group.
- Reviewer
Mode - Whether a reviewer is asked or skipped.
- Reviewer
Type - The kind of reviewer that may bypass secret scanning push protection.
- Runner
Type - Where code scanning runs.
- Security
Alerts Threshold - The security alert severity at which code scanning blocks a change.
- Setup
State - Whether code scanning default setup is on.
- Source
Path - The folder of the source branch that a legacy site publishes.
- Squash
Merge Commit Message - The message of a squash merge commit.
- Squash
Merge Commit Title - The title of a squash merge commit.
- Status
- Whether a security feature is on.
- Target
- The kind of ref a ruleset covers.
- Threat
Model - The sources code scanning treats as untrusted.
- Visibility
- Who can see the repository.