Skip to main content

Module proposal

Module proposal 

Source
Expand description

Automated proposal analysis and isolated release-branch maintenance.

Modulesยง

analysis ๐Ÿ”’
Version bump analysis. Callers supply what Git observed about each unit and how to find the required bump, so the policy here stays pure.
assets ๐Ÿ”’
Dependency assets built from the worktree of the dependency release to pin their digests.
branch ๐Ÿ”’
Mirrored proposal branch maintenance in a disposable worktree.
groups ๐Ÿ”’
Release units grouped and ordered for one commit each.
metadata ๐Ÿ”’
Ownership marker embedded in the maintained proposal PR body.

Structsยง

ConfiguredProposal
Inputs for applying and synchronizing a configured release proposal.
ProposalWrite ๐Ÿ”’
Everything needed to write a proposal into a worktree.
Revisions ๐Ÿ”’
Revision-file edits that accompany a proposal.
Synchronized ๐Ÿ”’
The branch after a proposal run and the units it left out.

Enumsยง

ProposalError ๐Ÿ”’
A release proposal cannot be analyzed or synchronized.
ProposalOutcome
What a proposal run did.

Functionsยง

propose
Maintain the release proposal branch and its pull request.
propose_versions ๐Ÿ”’
The versions a proposal sets: explicit requests completed to their groups, then the automatic bumps analysis derives from Git history. The proposal carries the dependency updates of each bumped unit.
sync_mode ๐Ÿ”’
Regenerate on request. Otherwise refresh only what the pull request vouches for.
sync_proposal ๐Ÿ”’
Discover configured units, analyze changes, and synchronize the maintained release branch using the evaluated release policy. expectation comes from the open proposal pull request.
without_unfinished ๐Ÿ”’
Split off the pending units, whose file version waits for publication. The remaining units no longer depend on the removed ones.