GithubOperator

GitHub

GithubOperator to interact and perform action on GitHub API. This operator is designed to use GitHub Python SDK: https://github.com/PyGithub/PyGithub

View on GitHub

Last Updated: Feb. 22, 2023

Access Instructions

Install the GitHub provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.

Parameters

github_conn_idReference to a pre-defined GitHub Connection
github_methodRequiredMethod name from GitHub Python SDK to be called
github_method_argsMethod parameters for the github_method. (templated)
result_processorFunction to further process the response from GitHub API

Documentation

GithubOperator to interact and perform action on GitHub API. This operator is designed to use GitHub Python SDK: https://github.com/PyGithub/PyGithub

See also

For more information on how to use this operator, take a look at the guide: Operators

Was this page helpful?