GithubRunner (autotransform.runner.github)
The implementation for the GithubRunner.
- class autotransform.runner.github.GithubRunner(*, run_workflow: str, update_workflow: str, repo_name: Optional[str] = None, repo_ref: Optional[str] = None)
Bases:
RunnerA Runner component that is used to trigger Github workflows. See examples/workflows/autotransform.run.yml.
- run_workflow
The name of the workflow to use for running a Schema.
- Type
str
- update_workflow
The name of the workflow to use for updating a Change.
- Type
str
- repo_name
The name of the Github repo to trigger actions from. If not provided, the repo of the Schema will be used. Defaults to None.
- Type
optional, Optional[str]
- repo_ref
The ref of the Github repo to trigger actions from. If not provided, the base branch of the Schema’s repo will be used. Defaults to None.
- Type
optional, Optional[str]
- name
The name of the component.
- Type
ClassVar[RunnerName]
- name: ClassVar[RunnerName] = 'github'
- repo_name: Optional[str]
- repo_ref: Optional[str]
- run(schema: AutoTransformSchema) None
Triggers a full run of a Schema by submitting a workflow run to the Github repo in the Schema.
- Parameters
schema (AutoTransformSchema) – The schema that will be run.
- run_workflow: str
- update(change: Change) None
Triggers an update of the Change by submitting a workflow run to the Github repo in the Schema associated with the change.
- Parameters
change (Change) – The Change to update.
- update_workflow: str