Source code for academic_observatory_workflows.github

# Copyright 2021-2022 Curtin University
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Author: James Diprose

from __future__ import annotations

import json

import requests
from airflow import AirflowException


[docs]def trigger_repository_dispatch(*, org: str, repo_name: str, token: str, event_type: str):
    """Trigger a GitHub repository dispatch event.

    :param org: the GitHub organisation / username.
    :param repo_name: the repository name.
    :param token: the GitHub token.
    :param event_type: the event type
    :return: the response.
    """

    headers = {
        "Accept": "application/vnd.github.v3+json",
        "Authorization": f"token {token}",
    }
    data = {"event_type": event_type}

    response = requests.post(
        f"https://api.github.com/repos/{org}/{repo_name}/dispatches",
        headers=headers,
        data=json.dumps(data),
    )
    if response.status_code != 204:
        raise AirflowException(f"trigger_repository_dispatch: {response.status_code}, {response.text}")