openedx / openedx/openedx-webhooks
Move internal-ghorgs to salesforce and drop `orgs.yaml`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 13
- Forks
- 22
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 4
Description
This is follow-up from the work done in https://github.com/openedx/openedx-webhooks/issues/207, which allowed us to delete people.yaml
The only thing we still use the manually-maintained orgs.yaml file for is the internal-ghorgs settings, which tells the OSPR bot that it can bypass automated triage process for certain "internal" entities like Axim, 2U, and Arbisoft.
If we were able to move this setting into Salesforce and pull it down from salesforce-export.csv, it would make it so all our OSPR data is is a single, auto-updating file.
Furthermore, if we can use Salesforce to validate the data, then we no longer need to run unit tests on https://github.com/openedx/openedx-webhooks-data just to validate the consistency of the data files.
Value:
- Simpler for Axim on-call to understand how this all works
- Less openedx-webhooks code to maintain
- Less potential for confusion around outdated data in orgs.yaml
- Potentially able to archive https://github.com/openedx/openedx-webhooks-data-schema/ and remove the unit tests from https://github.com/openedx/openedx-webhooks-data
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the follow-up in issue 207 and tracing how tests/repo_data/openedx/openedx-webhooks-data/orgs.yaml supplies the OSPR bot's internal-ghorgs setting. Compare that flow with salesforce-export.csv and the validation responsibilities in openedx-webhooks-data-schema. Done means internal-ghorgs is sourced from Salesforce, orgs.yaml is no longer needed, and the affected data-validation tests or repositories have an explicit outcome.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100