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 ¶
const BranchEnv = "AR2_BRANCH_TOKEN"
BranchEnv holds the token that creates the package branches.
Creating one has to get past the ruleset requiring status checks, which a brand new branch can't have. The app behind it is listed as a bypass actor for that ruleset and holds no pull-requests permission, so it can't open or merge a pull request and the bypass can't become a way to land an unchecked change.
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 ¶
Types ¶
This section is empty.
Source Files