The verify phase's flow: a member's published wheel against its own tests.
The pairing under test is the one a consumer gets: the wheel the
index serves, installed into a plain virtual environment beside the
tests recorded for that same version, so the tree is checked out at
the release tag, never at main, and the package must import from
site-packages, never from the workspace. A red verification means a
dependency release broke the installed configuration or the index
artifact drifted; the failure path files or extends the marker
issue through the forge, searching for the marker first, so a red
night is one issue with one comment per failure, never a pile.
Reach for livery.workshop._verify.verify_flow; fm release.verify
is its verb, and the nightly point schedules it through the
contract's [[ci.schedule]] seam.
Classes:
| Name |
Description |
Registry |
The one probe the verification needs; livery.forge.SimpleRegistry fits.
|
Verification |
What one verification is about.
|
Functions:
| Name |
Description |
latest_release |
The newest final release the index serves for dist; refuses when none.
|
run_url |
The run's page from the runner's environment; empty outside CI.
|
report_failure |
File or extend the marker issue; the line saying which, or the refusal.
|
verify_flow |
Verify package's latest release on python; red files the issue and fails.
|
Attributes:
MARKER
module-attribute
MARKER = 'nightly: released-wheels verification failed'
Registry
Bases: Protocol
The one probe the verification needs; livery.forge.SimpleRegistry fits.
Methods:
| Name |
Description |
versions |
The published versions of name.
|
versions
The published versions of name.
Source code in packages/workshop/src/livery/workshop/_verify.py
| def versions(self, name: str) -> tuple[str, ...]:
"""The published versions of *name*."""
...
|
Verification
dataclass
Verification(member: str, dist: str, version: str, extras: str = '')
What one verification is about.
Attributes:
| Name |
Type |
Description |
member |
str
|
The member's directory name under packages/.
|
dist |
str
|
|
version |
str
|
The released version under test.
|
extras |
str
|
The extras to install with it, comma-joined; empty for none.
|
member
instance-attribute
version
instance-attribute
tag
property
The receipt tag the tree is checked out at.
requirement
property
The exact requirement the plain environment installs.
latest_release
The newest final release the index serves for dist; refuses when none.
Only x.y.z versions count: a dev or pre-release is never the
consumer's pairing.
Source code in packages/workshop/src/livery/workshop/_verify.py
| def latest_release(registry: Registry, dist: str) -> str:
"""The newest final release the index serves for *dist*; refuses when none.
Only ``x.y.z`` versions count: a dev or pre-release is never the
consumer's pairing.
"""
finals = [v for v in registry.versions(dist) if _RELEASE_RE.match(v)]
if not finals:
fail(f"the index serves no released version of {dist}: nothing to verify")
return max(finals, key=lambda v: tuple(int(part) for part in v.split(".")))
|
run_url
The run's page from the runner's environment; empty outside CI.
Source code in packages/workshop/src/livery/workshop/_verify.py
| def run_url() -> str:
"""The run's page from the runner's environment; empty outside CI."""
server = os.environ.get("GITHUB_SERVER_URL", "")
repository = os.environ.get("GITHUB_REPOSITORY", "")
run_id = os.environ.get("GITHUB_RUN_ID", "")
if server and repository and run_id:
return f"{server}/{repository}/actions/runs/{run_id}"
return ""
|
report_failure
File or extend the marker issue; the line saying which, or the refusal.
Source code in packages/workshop/src/livery/workshop/_verify.py
| def report_failure(repo: Repository, verification: Verification, *, url: str) -> str:
"""File or extend the marker issue; the line saying which, or the refusal."""
from livery.forge import ForgeError
evidence = f"{verification.requirement} failed its verification" + (
f": {url}" if url else ""
)
try:
existing = repo.issue.search(MARKER)
if existing:
repo.issue.comment(existing[0].number, f"Failed again: {evidence}")
return f" commented on #{existing[0].number}: {evidence}"
created = repo.issue.create(
MARKER,
body=(
"The released-wheels verification is red: the wheel on the"
" index does not pass its own recorded tests in the consumer"
f" configuration.\n\n{evidence}\n\nThe verification installs"
" the released wheel into a plain virtual environment and runs"
" the member's tests at the release tag. A red verification"
" means a dependency release broke the installed configuration,"
" or the index artifact drifted; the run's logs carry the"
" failing tests."
),
)
return f" filed #{created.number}: {MARKER}"
except ForgeError as error:
return f" the forge refused the issue: {error}"
|
verify_flow
Verify package's latest release on python; red files the issue and fails.
The release is the newest final version registry serves; the
tree is a temporary worktree at its receipt tag, refused when
the checkout lacks the tag. The install and the test run are the
package's verify phase, through
livery.workshop._lifecycle.verify. With repo, a red
verification files or extends the marker issue before failing.
Source code in packages/workshop/src/livery/workshop/_verify.py
| def verify_flow(
root: Path,
package: Package,
*,
python: str,
registry: Registry,
index: str,
extras: str = "",
repo: Repository | None = None,
) -> None:
"""Verify *package*'s latest release on *python*; red files the issue and fails.
The release is the newest final version *registry* serves; the
tree is a temporary worktree at its receipt tag, refused when
the checkout lacks the tag. The install and the test run are the
package's ``verify`` phase, through
[livery.workshop._lifecycle.verify][]. With *repo*, a red
verification files or extends the marker issue before failing.
"""
from livery.workshop import _lifecycle
member = package.member
verification = Verification(
member, package.name, latest_release(registry, package.name), extras
)
if verification.tag not in git.tags(root):
fail(
f"the checkout carries no tag {verification.tag}: fetch the tags"
" (git fetch --tags), or the release is not this repository's"
)
print(
f" verifying {verification.requirement} at {verification.tag} on python"
f" {python}"
)
scratch = scratch_dir("verify")
tree = scratch / "tree"
try:
git.worktree_add(root, tree, verification.tag, detach=True)
except git.GitError as error:
fail(str(error))
try:
code = _lifecycle.verify(
package,
root,
tree=tree,
version=verification.version,
python=python,
index=index,
extras=extras,
)
finally:
with contextlib.suppress(git.GitError):
git.worktree_remove(root, tree)
shutil.rmtree(scratch, ignore_errors=True)
if code == 0:
print(
f" green: {verification.requirement} passes its own tests from"
" site-packages"
)
return
if repo is not None:
print(report_failure(repo, verification, url=run_url()))
fail(f"the verification of {verification.requirement} is red (exit {code})")
|