When a repo is no longer used by Open edX (or internally at edX) and will no longer be supported, we archive it and move it to the edx-unsupported Github org.
This doc contains some differences with respect to OEP 14, but is more representative of our current process. The two should be reconciled (by updating OEP 14). |
Archive process:
Go through the “before archiving” checklist below
Go to the repo’s Settings page and choose “Archive this repository”
This will mark the repo in the Github UI as no longer maintained
Arch-BOM will be notified and will take care of moving the repo to edx-unsupported, removing it from the ownership spreadsheet, and notifying the listed owners
Before archiving:
Confirm that the repo is no longer used, both internally at edX, in Open edX, and in the latest Open edX named release.
If the repo is private, confirm that no one still needs read access to it – once it moves to edx-unsupported, very few people will have access to it (since the permission structure is different there)
If a repo cannot be moved, but edX is no longer able to maintain it, then the best alternative is to just put a note in the README explaining the situation and leave it until it's possible to actually archive the repo.