AnnounceReport (1 of 2)

AnnounceReportclassdataclass#

Re-exported from ocx_sdk._resultsView source

class AnnounceReport(package: str, status: str, desc_status: str, forge: str, transport: str, credential_kind: str, push_credential_kind: str | None, branch: str | None, pull_request_url: str | None, pull_request_number: int | None, fork: str | None, written_paths: tuple[str, ...], capability_checks: tuple[CapabilityCheck, ...], reserved_tags_dropped: tuple[str, ...])

ocx package announce — what reached the index (C-061).

Payload is bare (D11). Every one of the fourteen keys is always on the wire; the nullable ones are null rather than absent, so all are read with _need and typed | None where upstream is Option.

Attributes

Name	Type	Description
package	str	The announced <namespace>/<package>.
status	str	"updated" when a rebuilt root was committed, "unchanged" when it was byte-identical to the committed one. An unchanged run can still report a pull request it ensured.
desc_status	str	"updated" when the package’s __ocx.desc artifact moved, else "unchanged".
forge	str	"github" or "gitlab", as resolved.
transport	str	"api" or "git".
credential_kind	str	"job-token", "token" or "none" — what the identity ladder resolved for the API credential.
push_credential_kind	str | None	"job-token", "token", "git-helper", or None under the api transport, which pushes nothing.
branch	str | None	The announce branch, or None under --out.
pull_request_url	str | None	The request’s URL, when one was opened or ensured.
pull_request_number	int | None	Its number, likewise.
fork	str | None	The fork the request came from, when --fork was given.
written_paths	tuple[str, ...]	Files written under --out; empty otherwise.
capability_checks	tuple[CapabilityCheck, ...]	The forge probes, in CapabilityName order.
reserved_tags_dropped	tuple[str, ...]	__ocx and legacy sha256.<hex> tags named on the command line and dropped: a reported fact of a successful run, never a failure.

branchattributeinstance attribute#

View source

branch: str | None

capability_checksattributeinstance attribute#

View source

capability_checks: tuple[CapabilityCheck, ...]

credential_kindattributeinstance attribute#

View source

credential_kind: str

desc_statusattributeinstance attribute#

View source

desc_status: str

packageattributeinstance attribute#

View source

package: str

pull_request_numberattributeinstance attribute#

View source

pull_request_number: int | None

pull_request_urlattributeinstance attribute#

View source

pull_request_url: str | None