Figure out the future of the OSPR Bot

オープン
#289 コメント 4 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
20/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
github, python
領域
devops, tooling

調査の方向性

リンクされた openedx-webhooks pull request 159 と、ここで説明されている現在の GitHub OAuth または personal-access-token の設定を確認することから始めます。誰が bot に依存し、誰が bot を保守しているのか、issues はどこに置くべきか、また GitHub App と OAuth App のどちらが将来の統合として意図されているのかを明らかにします。完了条件は、コード変更ではなく、合意された方向性が定まっていることです。

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Python
スター
13
フォーク
22
平均マージ
1日 6時間
マージ済み PR(30日)
6

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

openedx/openedx-webhooks のほかの issue

openedx/openedx-webhooks の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。