Skip to main content

Module catalog

Module catalog 

Source
Expand description

The capability catalog: which complete release-kit product each embedded source belongs to, which dimensions select it, and whether it is available at the dimensions a target resolved to.

Availability belongs to a capability at its dimensions and never to a category alone: release.automation at (python, github) is available while the same capability at (python, gitlab) is unavailable. Every omission is recorded with one of the five reasons the vocabulary names, so a reader can tell a product nobody asked for from one this release cannot land.

The catalog is pure: it reads the snippet paths it is given and the resolved parameters, and nothing else.

SATISFIES project-profile:availability-belongs-to-a-capability-at-its-dimensions

Structs§

Availability
What the embedded sources can land: every snippet path, relative to snippets/, sorted.
Selection
One capability’s answer for one target.

Enums§

Status
The status of one capability for one target.

Constants§

ALL
Every capability, in the order a report lists them.
CODE_SCANNING
The code scanning workflow, by provider.
COMMIT_CHECK
The complete, active commit gate at the forge: the forge gate of the rebase merge form, which judges every commit of the request because each one reaches the trunk with its own message.
COMMIT_GATE_ZONE
The zone below snippets/ that carries the release-less GitLab root pipeline of the rebase merge form, which activates the commit fragment instead.
GUARDS
The release guards every valid target selects.
PACKAGING_NIX
The seeded package expression and the seed flake pair.
RELEASE_AUTOMATION
The release automation at one driver and one forge: the version source, the bot configuration, and the release workflow.
REPORTING_POLICY
The landed vulnerability reporting policy.
SCORECARD
The OpenSSF Scorecard workflow.
TITLE_CHECK
The complete, active title gate at the forge: the forge gate of the squash merge form, which judges the request’s title because it becomes the trunk’s commit message.
TITLE_GATE_ZONE
The zone below snippets/ that carries the release-less GitLab root pipeline: the minimal .gitlab-ci.yml that activates the title fragment where no release automation ships a root pipeline.
WORKFLOW_GUARDS
The opt-in workflow guards: the agent and commit policy lines of the routing block, the glossary, the workflow hooks, and the two workflow setup steps. Off for a fresh landing.

Functions§

build_answer_fits
Whether a build answer fits the release intent: an automatic bash release alone calls a project-supplied build command.
forge_gate_lands
Whether a target lands a forge gate at all.
known_drivers
The release drivers this binary’s sources know.
owner_of
The one owner of every embedded snippet: which capability lands the file at path, the path relative to snippets/.
pin_keys
The pin keys one selection matches in the registry’s used_by.
registry_answer_fits
Judge a stated profile.release.registry answer against its release.
select
Select every capability for params against availability.