Skip to main content

Module config

Module config 

Source
Expand description

The committed target configuration, parsed strictly and written from authored text, typed by the domain that owns each answer. Comparisons continue to use the landing record alone.

SATISFIES project-profile:the-target-configuration-is-typed-by-domain

Modules§

dev_environment
The dev_environment table: how a command runs in the project’s own development environment, and how CI puts that environment on a runner.
floors
The single owner of configuration policy judgments and their method sources.
migrate
The one bounded migration of a schema 1 configuration into the schema 2 domains, over the authored text, so every comment survives.

Structs§

Acquisition
The acquisition table: the host-install answer.
Bot
The setup.bot table.
Capabilities
The capabilities table: the optional products the target requests.
Config
Per-target answers; an omitted table uses its compiled defaults.
Git
The git table: the Git workflow parameters.
Github
The protection.github table.
Gitlab
The protection.gitlab table.
Plan
Resolved landing input, including every key a preview would write.
Profile
The profile table: what the project is.
Project
The project table: identity.
Protection
The protection table.
Release
The profile.release table.
Security
The security table.
Setup
The setup table.

Enums§

AcquisitionSource
Where every host obtains rk, where no manager file records a pin.

Constants§

COMMIT_GATE_CHECK
The context the landed commit gate reports under: the job name in pr-commits.yml, which the trunk ruleset requires under the rebase merge form in place of protection.title_check.
CONFIG_PATH
The committed input, relative to the target root.
LINEAR_HISTORY_RULE
The GitHub rule that refuses a merge commit on the trunk. The rebase merge form requires it, because a rebase merge alone does not stop a merge commit pushed past the request.
LINE_PREFIX_DEFAULT
The compiled release-line prefix, used where nothing else answers.
LOCAL_GITHUB_BYPASS
The one GitHub ruleset bypass local integration owns.
REQUEST_RULES
The rules the trunk ruleset carries: the request and the check it must carry, which a recorded bypass actor may be excused from.
RESPONSE_DEFAULT
The compiled response stance, used where nothing else answers: the policy promises no window at all.
SAFETY_RULES
The rules the safety ruleset carries, in the order the setup writes them.
SCHEMA_VERSION
The configuration schema this binary writes. Schema 1 reads through the one migration in migrate.
TRUNK_DEFAULT
The compiled trunk, used where neither a configuration nor a record answers.

Functions§

canonical_contact
The canonical form of a security contact, or why it is refused.
canonical_response
The canonical form of a response stance, or why it is refused.
check_writable
Refuse a configuration path that does not lead straight into the target.
line_prefix_of
The release-line prefix for callers without a setup context.
load
Read the optional file; content errors refuse instead of falling back.
merge_values
The merge method a forge allows on the trunk under one merge form, and the GitLab squash setting that goes with it.
pending
Only explicit class P answers can be pending; comparisons still use the record.
rewrite_key
Change one landing parameter while preserving comments and table ordering.
set_migration
Set or remove the open migration in the target’s configuration, writing a file that states the key alone where none exists.
trunk_of
The trunk accessor for callers without a setup context.
with_acquisition
The configuration text with the acquisition answer recorded, and whether that changes anything.
with_merge_form
The policy with the merge values form names.
with_migration
The text with the top-level migration key set, or removed where id is None, every other byte kept.
write
Write the authored template with TOML-escaped scalar substitutions.