Skip to content
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

Closed
wants to merge 12 commits into from

Conversation

bmedx
Copy link
Contributor

@bmedx bmedx commented Aug 11, 2021

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:

  • Fix linting issues
  • Add "no pii" annotations to models which clearly have no PII in them

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

  • Make sure your requirements are up to date
  • Make sure you have applied migrations
  • Shell into LMS Devstack and run:
  • 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 none
  • code_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

@edx-status-bot
Copy link

Your PR has finished running tests. There were no failures.

@e0d
Copy link
Contributor

e0d commented Nov 20, 2023

@bmtcril should we close this one?

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 20, 2023
@openedx-webhooks
Copy link

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:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

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.

⚠️ We can't start reviewing your pull request until you've submitted a signed contributor agreement or indicated your institutional affiliation. Please see the CONTRIBUTING file for more information. If you've signed an agreement in the past, you may need to re-sign. See The New Home of the Open edX Codebase for details.

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 @openedx/cla-problems team in a comment on your PR for further assistance.

@mphilbrick211 mphilbrick211 added the inactive PR author has been unresponsive for several months label Nov 21, 2023
@bmtcril
Copy link
Contributor

bmtcril commented Nov 21, 2023

@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.

@bmtcril
Copy link
Contributor

bmtcril commented Feb 29, 2024

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

@bmtcril bmtcril closed this Feb 29, 2024
@openedx-webhooks
Copy link

@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.

@kdmccormick kdmccormick deleted the bmedx/hack_update_pii_annotations branch May 15, 2024 19:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
inactive PR author has been unresponsive for several months open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

6 participants