Figure out the future of the OSPR Bot

Open
#289 4 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
github, python
Domain
devops, tooling

Research direction

Start by reviewing the linked openedx-webhooks pull request 159 and the current GitHub OAuth or personal-access-token setup described here. Resolve who depends on and maintains the bot, where issues belong, and whether a GitHub App or OAuth App is the intended future integration; done requires an agreed direction rather than a code change.

Written by the indexing model from the issue text.

Description

discovery

Decoupling questions

In light of the edX-tCRIL decoupling and increasing distribution of code ownership...

Who will depend on the bot, and for what?

  • edX: creating and linking Jira tickets for each OSPR on the Jira project of the owning team.
  • tCRIL: putting OSPRs on our team project board for code we own?
  • others firms: pushing to their preferred issue tracking system when a PR is opened on owned code?
  • tCRIL: automating the CLA flow by hooking into Salesforce.
  • anything else?

Who will maintain the bot?

  • edX Arch-BOM?
  • tCRIL?

Where do bot-related issues go?

  • edX Jira, in the BOM project?
  • this tcril-engineering GitHub repo?

Other issues

Cataloging these here until we have a proper place for issues.

Personal access token vs App

Until recently, the OSPR bot was implemented as an OAuth App in GitHub. Because the openedx GitHub org is configured not to allow arbitrary OAuth Application access, we either needed to
(i) do the legwork to make the OSPR bot an approved OAuth App, or
(ii) change the bot to use a personal access token from the openedx-webhooks account, or
(iii) change the openedx GitHub org to allow arbitrary OAuth application access.

We took approach (ii).

We have some concern that because this is not the "proper" way to integrate with GitHub (they technically have a one-user-account-per-human policy) that this may expose us to being rate-limited more aggressively than if it were a proper OAuth App or GitHub App (which, mind you, are different things). For now, we've decided to proceed with a personal access token, with Ned keeping an eye on the logs to see if we're approaching or hitting a rate limit.

In the future, though, it would probably be prudent to turn the OSPR bot into an approved GitHub App or OAuth App.

Dominant language
Python
Stars
13
Forks
22
Avg merge
1d 6h
Merged PRs (30d)
6

Getting set up

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 openedx/openedx-webhooks

All issues in openedx/openedx-webhooks

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.