-
Notifications
You must be signed in to change notification settings - Fork 3.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update PII annotations and fix annotation linting issues #28446
Conversation
celery_utils.FailedTask has been annotated in the parent repo, so no longer needs to be in the platform .annotation_safe_list.yml
Other edX repos (at least edx-proctoring) have added this annotation type, which seems reasonable. Including those packages in platform breaks linting, so adding it here for consistency and to fix linting.
Your PR has finished running tests. There were no failures. |
@bmtcril should we close this one? |
Thanks for the pull request, @bmedx! Please note that it may take us up to several weeks or months to complete a review and merge your PR. Feel free to add as much of the following information to the ticket as you can:
All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here. Please let us know once your PR is ready for our review and all tests are green. Once you've signed the CLA, please allow 1 business day for it to be processed. After this time, you can re-run the CLA check by adding a comment here that you have signed it. If the problem persists, you can tag the |
@e0d I think there's a larger conversation to be had around OEP-30 and whether we want to track PII in the system. I think it might be valuable to run this again to at least audit the current state of retirement in the platform. |
I'm not going to get to this soon, so have created this issue to track the larger work around PII / OEP-30: openedx/wg-data#33 |
@bmedx Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future. |
Description
The OEP-30 checker has not been running in edx-platform CI for some time. The number of models lacking PII annotations has gone up quite a bit in that time, with coverage dropping from 94.5% to 82.9% in the Devstack environment, and some annotation linting issues have been introduced along the way. Locally these commits brought the coverage back up to 88.6%, with the majority of remaining issues being historical models that we'd normally just drop the coverage % for anyway.
This PR is a collection of fixes that represent some of the output of my 8/2021 hackathon project:
Additional notes and output from this hackathon project will be here: https://openedx.atlassian.net/wiki/spaces/~bmesick/pages/3102998898/8+2021+Doc+Hackation+PII+Annotations+Output
Testing instructions
export DJANGO_SETTINGS_MODULE=lms.envs.devstack_docker
code_annotations django_find_annotations --config_file .pii_annotations.yml --lint
to check for linting violations, there should be nonecode_annotations django_find_annotations --config_file .pii_annotations.yml --coverage
to check the coverage percentage. This can vary based on your configuration, but my run on edx-platform master yielded 88.6%.Deadline
None