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

Cleaning up PII annotations #2293

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

bmtcril
Copy link

@bmtcril bmtcril commented Nov 20, 2024

Adding some missing annotations, fixing typo'd annotation, removing what seem like unnecessary annotations from the safe list. This work is in preparation for getting the annotation checker running on edx-platform again. I don't think this work should merit a version bump or release, it's just changes to comments and the safe list.

Merge checklist:

  • Any new requirements are in the right place (do not manually modify the requirements/*.txt files)
    • base.in if needed in production but edx-platform doesn't install it
    • test-master.in if edx-platform pins it, with a matching version
    • make upgrade && make requirements have been run to regenerate requirements
  • make static has been run to update webpack bundling if any static content was updated
  • ./manage.py makemigrations has been run
    • Checkout the Database Migration Confluence page for helpful tips on creating migrations.
    • Note: This must be run if you modified any models.
      • It may or may not make a migration depending on exactly what you modified, but it should still be run.
    • This should be run from either a venv with all the lms/edx-enterprise requirements installed or if you checked out edx-enterprise into the src directory used by lms, you can run this command through an lms shell.
      • It would be ./manage.py lms makemigrations in the shell.
  • Version bumped
  • Changelog record added
  • Translations updated (see docs/internationalization.rst but also this isn't blocking for merge atm)

Post merge:

  • Tag pushed and a new version released
    • Note: Assets will be added automatically. You just need to provide a tag (should match your version number) and title and description.
  • After versioned build finishes in GitHub Actions, verify version has been pushed to PyPI
    • Each step in the release build has a condition flag that checks if the rest of the steps are done and if so will deploy to PyPi.
      (so basically once your build finishes, after maybe a minute you should see the new version in PyPi automatically (on refresh))
  • PR created in edx-platform to upgrade dependencies (including edx-enterprise)
    • Trigger the 'Upgrade one Python dependency' action against master in edx-platform with new version number to generate version bump PR
    • This must be done after the version is visible in PyPi as make upgrade in edx-platform will look for the latest version in PyPi.
    • Note: the edx-enterprise constraint in edx-platform must also be bumped to the latest version in PyPi.

moodle.HistoricalMoodleEnterpriseCustomerConfiguration:
".. no_pii:": ""
enterprise.EnterpriseCourseEntitlement:
Copy link
Author

@bmtcril bmtcril Nov 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this one and the next are necessary here, I annotated them on the models, but if we need them here let me know so I can comment why.

@bmtcril bmtcril force-pushed the bmtcril/pii_annotations branch 2 times, most recently from bdcff66 to 1ded57a Compare November 20, 2024 20:41
Adding some missing annotations, fixing typo'd annotation, removing what
seem like unnecessary annotations from the safe list. This work is in
preparation for getting the annotation checker running on edx-platform
again.
@bmtcril bmtcril force-pushed the bmtcril/pii_annotations branch from 1ded57a to 9f8dcda Compare November 22, 2024 20:07
@bmtcril
Copy link
Author

bmtcril commented Nov 22, 2024

Hey @pwnage101 ! It looks like you were the last one to touch this stuff, do you think you could review this or point me to someone who could?

@bmtcril
Copy link
Author

bmtcril commented Dec 4, 2024

Not sure who might be able to review here, @adamstankiewicz could you maybe point me in the right direction?

@macdiesel macdiesel enabled auto-merge December 5, 2024 18:49
@macdiesel
Copy link
Contributor

Thanks for the PR Bmez

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants