Chain of Trust on Github: Migrate to the v4 API

Open
#367 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Stale
Tech stack
github, python
Domain
api, backend

Research direction

Start with scriptworker/github.py lines 102-132 and the GitHub v4 migration guide linked in the issue. Review issue 331 and the existing response-caching behavior, then map the current v3 and non-API calls to GraphQL equivalents. Done means the GitHub interactions use v4 and the affected caching logic is addressed without regressing the worker.

Written by the indexing model from the issue text.

Description

We're using the v3 API, because that was the one officially supported at the time.

This led us (for instance) to use this non-API call: https://github.com/mozilla-releng/scriptworker/blob/053e76b1a0e8bbc816c5cee4a3b5e07a081f576a/scriptworker/github.py#L102-L132

That call created issues like https://github.com/mozilla-releng/scriptworker/issues/331, where we ended up manually caching the responses.

Moving to the GraphQL API may help us in removing that caching logic

https://developer.github.com/v4/guides/migrating-from-rest/

Dominant language
Python
Stars
5
Forks
39
Avg merge
4h 18m
Merged PRs (30d)
6

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mozilla-releng/scriptworker

All issues in mozilla-releng/scriptworker

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.