Skip to content

fix: added inline commit lint - #39022

Merged
bmtcril merged 5 commits into
openedx:masterfrom
Akanshu-2u:aaich/BOMS-587-annotate
Aug 25, 2026
Merged

fix: added inline commit lint#39022
bmtcril merged 5 commits into
openedx:masterfrom
Akanshu-2u:aaich/BOMS-587-annotate

Conversation

@Akanshu-2u

@Akanshu-2u Akanshu-2u commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Description

With the upgrade of edx-lint to the latest version, 6.2.0, a new PII annotation check has been introduced. This may result in linter issues for both true positives and false positives.

This PR addresses those issues by correcting the PII annotations for true positives and adding inline comments to suppress the linter for false positives.

Changes

  • Corrected the no_pii annotations for models that contain PII fields.
  • Added inline pylint comments to suppress false-positive PII linter warnings where the detected fields do not contain PII.

Relevant PR:

Private JIRA Link:

BOMS-587

@Akanshu-2u
Akanshu-2u requested a review from a team as a code owner August 25, 2026 09:35
Bump edx-lint to latest. This will need openedx#39022 to fast-follow to prevent failing checks.

Commit generated by workflow `openedx/openedx-platform/.github/workflows/upgrade-one-python-dependency.yml@refs/heads/master`

@bmtcril bmtcril left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM, just noting that the edx-lint version bump commit was taken from a real run of the "upgrade-one-python-dependency" action. Included here since it needs to merge with these changes to prevent issues with lint checks failing.

@bmtcril
bmtcril merged commit 457ab6f into openedx:master Aug 25, 2026
52 of 58 checks passed
),
)
# pylint: disable-next=pii-invalid-no-pii-annotation # field does not store user PII data, safe under OEP-30
skip_email_verification = models.BooleanField(

@robrap robrap Aug 25, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@Akanshu-2u: If it is simple, an enhancement to consider is to have the linter skip anything that is a BooleanField.

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.

3 participants