token

package
v0.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 10, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package token builds the GitHub clients ar2 uses beside the ordinary one.

Both are GitHub App installation tokens, and both exist because of something the repository's own GITHUB_TOKEN can't do. Neither is required: without them the ordinary client is used, which is what a local run does and what works in a repository with no rulesets.

Index

Constants

View Source
const PREnv = "AR2_PR_TOKEN"

PREnv holds the token that commits to the head branches and opens the pull requests.

A pull request opened or updated with GITHUB_TOKEN gets its workflow runs in an approval-required state, so nothing checks it until a person presses a button. A registry that opens pull requests on a schedule would need someone for every one of them, and auto-merge would never fire. A GitHub App installation token doesn't carry that restriction.

The app is not a bypass actor for anything: it opens pull requests and that is all, so the checks still decide what merges.

Variables

This section is empty.

Functions

func Client

func Client(env string) (*gogithub.Client, error)

Client returns a client for the token in env, or nil when it isn't set.

func HTTPClient added in v0.8.0

func HTTPClient(ctx context.Context, env string) *http.Client

HTTPClient returns an HTTP client carrying the token in env, or nil when it isn't set.

It is for the parts of GitHub ar2 reaches through GraphQL, which take a client rather than a token.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL