Skip to main content

Module eligible

Module eligible 

Source
Expand description

Whether a release is worth a request: a packed change, and a releasing commit among the commits that made it.

The packed change says what ships; the type of a commit says whether the change is worth a release. A request opens only where the packed set or a packed file changed since the last release and at least one commit that touched the packed set is a releasing commit, by the one classifier crate::integrate::release_intent: feat, fix, perf, or any type a ! or a breaking footer marks. The commits that do not release still count for the changelog. With no release tag the whole history is read.

One function, eligible, judges every driver. The bash and python request calls it after the packed-change check and before git-cliff bumps; rk release eligible answers it for every driver, and a rust target’s request job runs that verb before release-plz.

SATISFIES release-engine:a-request-needs-a-releasing-commit

Structs§

Commit
One commit that touched the packed set.
EligibleReport
The machine form of rk release eligible.
Verdict
What eligible answered.

Constants§

RELEASING
The releasing types, as the reasons name them.
SCHEMA
The report’s shape version.

Functions§

commits
The commits of <since>..HEAD, or of the whole history with no release tag, that touched any of paths, newest first.
eligible
Whether the commits of <since>..HEAD, or of the whole history with no release tag, that touched paths hold a releasing commit.
engine
The engine’s judgment for a bash or python target.
judge
Judge the commits that touched the packed set, pure.
parse_log
The commits of one git log --format=%x1e%H%x00%B listing.
run
Answer whether the change since the last release is worth a release, for the driver the record names. It writes nothing and reads no forge: the last release is the release tag git holds.