cicd.providers.github

cicd.providers.github.client

class cicd.providers.github.client.GithubClient

Bases: ProviderClient

BASE_URL: str | None = 'https://api.github.com'
get_project(identifier: int | str, **kwargs)

Get the details of a project.

Parameters:

identifier – The identifier of the project.

get_projects(**kwargs)

Get the list of (public) projects.

get_pull_request(project_identifier: int | str, identifier: int | str, **kwargs)

Get the details of a pull/merge request.

Parameters:
  • project_identifier – The identifier of the project.

  • identifier – The identifier of the pull/merge request.

get_pull_requests(project_identifier: int | str, state: str | None = None, **kwargs)

Get the pull/merge requests of the given project.

Parameters:
  • project_identifier – The identifier of the project.

  • state – The state (ex. open/closed/all) of the pull/merge requests.

cicd.providers.github.env

class cicd.providers.github.env.GithubEnv

Bases: Env