repomatic.metadata.env module

GitHub Actions environment accessors of Metadata.

Every property here reads the workflow-run environment (the event payload, the GITHUB_* variables) and nothing else: no git, no pyproject.toml.

class repomatic.metadata.env.EnvironmentMetadata

Bases: object

Workflow-run environment: the event payload and GITHUB_* variables.

A concern mixin of Metadata: never instantiated on its own, and reads sibling concerns through self.

property event_type: WorkflowEvent | None

Returns the type of event that triggered the workflow run.

Maps event_name (the GITHUB_EVENT_NAME variable, set by GitHub Actions on every run) onto its WorkflowEvent member, so schedule and workflow_dispatch runs resolve to their own event instead of falling in a None hole that nulls every commit matrix.

Caution

When GITHUB_EVENT_NAME is absent or unrecognized, falls back on the historical heuristic: a non-empty GITHUB_BASE_REF means a pull request (only set for pull request events), a present-but-empty one means a push.

property event_actor: str | None

Returns the GitHub login of the user that triggered the workflow run.

property event_sender_type: str | None

Returns the type of the user that triggered the workflow run.

property is_bot: bool

Returns True if the workflow was triggered by a bot or automated process.

This is useful to only run some jobs on human-triggered events. Or skip jobs triggered by bots to avoid infinite loops.

The sender type covers every GitHub App, which is how Dependabot and Renovate author their pull requests today. The explicit login list is kept as a second signal for downstream repositories: sender.type is absent from the event payload outside push and pull_request (and empty when the payload cannot be read at all), and the login is then the only thing left to match on.

The test is deliberately not sender.type != "User", which would also classify an Organization sender as a bot.

property head_branch: str | None

Returns the head branch name for pull request events.

For pull request events, this is the source branch name (e.g., update-mailmap). For push events, returns None since there’s no head branch concept.

The branch name is extracted from the GITHUB_HEAD_REF environment variable, which is only set for pull request events.

property event_name: str | None

Returns the name of the event that triggered the workflow.

Reads GITHUB_EVENT_NAME. This is the raw event name ("push", "pull_request", "workflow_run"), which event_type resolves to a WorkflowEvent member.

property job_name: str | None

Returns the ID of the current job in the workflow.

Reads GITHUB_JOB.

property ref_name: str | None

Returns the short ref name of the branch or tag.

Reads GITHUB_REF_NAME.

property repo_name: str | None

Returns the repository name without owner prefix.

Derived from repo_slug by splitting on /.

property is_awesome: bool

Whether this is an awesome-list repository.

Detected by the awesome- prefix on the repository name.

property repo_owner: str | None

Returns the repository owner.

Reads GITHUB_REPOSITORY_OWNER, falling back to the owner component of repo_slug.

property repo_slug: str | None

Returns the owner/name slug for the current repository.

Resolution order: GITHUB_REPOSITORY env var (CI), gh repo view (authenticated local), git remote URL parsing (offline fallback).

property repo_url: str | None

Returns the full URL to the repository.

Derived from server_url and repo_slug.

property run_attempt: str | None

Returns the run attempt number.

Reads GITHUB_RUN_ATTEMPT.

property run_id: str | None

Returns the unique ID of the current workflow run.

Reads GITHUB_RUN_ID.

property run_number: str | None

Returns the run number for the current workflow.

Reads GITHUB_RUN_NUMBER.

property server_url: str

Returns the GitHub server URL.

Reads GITHUB_SERVER_URL, defaulting to https://github.com.

property sha: str | None

Returns the commit SHA that triggered the workflow.

Reads GITHUB_SHA.

property triggering_actor: str | None

Returns the login of the user that initiated the workflow run.

Reads GITHUB_TRIGGERING_ACTOR. This differs from event_actor (GITHUB_ACTOR) when a workflow is re-run by a different user.

property workflow_ref: str | None

Returns the full workflow reference.

Reads GITHUB_WORKFLOW_REF. The format is owner/repo/.github/workflows/name.yaml@refs/heads/branch.