GitHub_Get_files_changed_on_pull_request.ipynb

Kernel: Python 3

GitHub - Get files changed on pull request

Give Feedback | Bug report

Tags: #github #pullrequest #files #api #python #git

Author: Florent Ravenel

Last update: 2023-04-12 (Created: 2023-03-09)

Description: This notebook get the list of files changed on a pull request using the GitHub API. Files changed could be 'added', 'renamed' or 'removed'.

References:

• GitHub API Documentation

• GitHub Pull Request API Documentation

Input

Import libraries

import requests
import naas
from pprint import pprint

Setup Variables

• token: Create your personal access token here

• owner: owner of the repository

• repo: name of the repository

• pull_number: number of the pull request

token = naas.secret.get("GITHUB_TOKEN") or "GITHUB_TOKEN"
owner = "jupyter-naas"
repo = "awesome-notebooks"
pull_number = 1496

Model

Get files changed on pull request

This function will use the GitHub API to get the list of files changed on a pull request.

def get_files_changed_on_pull_request(owner, repo, pull_number):
    url = f"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/files"
    response = requests.get(url)
    return response.json()

files_changed = get_files_changed_on_pull_request(owner, repo, pull_number)

Output

Display result

for file in files_changed:
    filename = file["filename"]
    status = file["status"]
    print(f"{filename}: {status}")