Overview

In developing the ability to annotate PII in any repository, we want to also adhere to OEP-2. OEP-2 specifies an openedx.yaml file that lives at the top-level of each code repository. The file describes the state of each repo in regards to other standards, along with declaring ownership and other things. It's important that openedx.yaml correctly reflects the state of annotated PII over time, particularly when a code repository contains annotated PII.

To ensure that openedx.yaml stays properly updated for OEP-30, a CI-run test will be developed that will run against all PRs in a repository. The CI will fail if annotated PII is added without properly updating openedx.yaml.

Details

The OEP-30 checking will be implemented in the repo-tools repository. That repo is not currently uploaded to PyPI - we'll perform that upload so that repo-tools will be able to be installed via pip. Once installed, the CI check will be invoked by a cmd-line command, such as:

oep30 check --username=<> –