fix: added edx-lint version upgrade - #430
Conversation
There was a problem hiding this comment.
Pull request overview
This PR upgrades the edx-lint dependency used in development/testing environments and updates pylintrc to match the configuration generated by the newer edx-lint version.
Changes:
- Bump
edx-lintfrom5.6.0to6.2.0in the pip-compiled testing and development requirement lockfiles. - Regenerate/update
pylintrcmetadata to reflect the newedx-lintversion. - Enable a new PII-related pylint message and add a
[PII]configuration section.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| requirements/edx/testing.txt | Updates the pinned edx-lint version used for testing dependencies. |
| requirements/edx/development.txt | Updates the pinned edx-lint version used for development dependencies (which include testing deps). |
| pylintrc | Updates generated-by metadata and adds PII-related lint configuration aligned with edx-lint 6.2.0. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.
Suppressed comments (4)
requirements/edx/testing.in:24
- This introduces a GitHub VCS dependency in testing.in using a personal fork and a moving branch name (
@master) and omits the required==VERSIONin the#egg=fragment. This conflicts with the repository’s documented convention for GitHub-hosted dependencies (requirements/edx/github.in:24-68): add GitHub dependencies there, include an issue link, and pin to a tag or SHA (no branches; non-openedx owners must use a SHA).
git+https://github.com/Akanshu-2u/edx-lint.git@master#egg=edx-lint # pylint extensions for Open edX repositories
requirements/edx/testing.txt:594
- This autogenerated lockfile now pins edx-lint from a moving Git branch (
@master) and without an explicit==VERSIONin#egg=, which makes installs non-reproducible and breaks the documented GitHub dependency format (requirements/edx/github.in:24-68). The generated requirements should be based on a deterministic edx-lint source (preferably a PyPI release, otherwise a tag/SHA recorded in requirements/edx/github.in) and then regenerated viamake upgrade.
# ora2
git+https://github.com/Akanshu-2u/edx-lint.git@master#egg=edx-lint # pylint extensions for Open edX repositories
# via -r requirements/edx/testing.in
requirements/edx/development.txt:769
- development.txt pins edx-lint to a different Git ref (
@aaich/BOMS-587-annotation) than testing.txt (@master). This can lead to inconsistent lint behavior between developer and CI/test environments, and it likely indicates the lockfiles were manually edited rather than regenerated consistently from the .in inputs.
# ora2
git+https://github.com/Akanshu-2u/edx-lint.git@aaich/BOMS-587-annotation#egg=edx-lint
# via -r requirements/edx/testing.txt
pylintrc:68
- pylintrc claims it was generated by edx-lint 6.2.0, but the requirements changes no longer deterministically pin edx-lint to 6.2.0 (they point at moving Git branches). This makes it hard to reproduce or regenerate this pylintrc reliably from the declared dependencies.
# ------------------------------
# Generated by edx-lint version: 6.2.0
# ------------------------------
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.
Suppressed comments (3)
requirements/edx/testing.txt:594
- The compiled requirements file now includes
edx-lintfrom a movingmasterbranch. Even if this works with pip, it makes the lockfile non-deterministic across time. Please regenerate withedx-lintpinned to an immutable version or commit SHA sorequirements/edx/testing.txtremains a true lockfile.
# -r requirements/edx/base.txt
# ora2
git+https://github.com/Akanshu-2u/edx-lint.git@master#egg=edx-lint # pylint extensions for Open edX repositories
# via -r requirements/edx/testing.in
requirements/edx/development.txt:768
development.txtsays thisedx-lintentry comes via-r requirements/edx/testing.txt, but it points at a different ref (aaich/BOMS-587-annotation) thanrequirements/edx/testing.txt(currentlymaster). This inconsistency can produce different environments between dev and test installs; these refs should match (and ideally be pinned immutably).
# -r requirements/edx/testing.txt
# ora2
git+https://github.com/Akanshu-2u/edx-lint.git@aaich/BOMS-587-annotation#egg=edx-lint
# via -r requirements/edx/testing.txt
pylintrc:68
pylintrcclaims it was generated byedx-lint6.2.0, but the requirements changes installedx-lintfrom a Git branch. If the installed code doesn’t actually correspond to 6.2.0, this header becomes misleading and makes it harder to debug lint behavior. Consider pinningedx-lintto 6.2.0 (or updating the header to include the exact commit SHA).
# ------------------------------
# Generated by edx-lint version: 6.2.0
# ------------------------------
| ddt # Run a test case multiple times with different input; used in many, many of our tests | ||
| edx-lint # pylint extensions for Open edX repositories | ||
| git+https://github.com/Akanshu-2u/edx-lint.git@master#egg=edx-lint # pylint extensions for Open edX repositories | ||
| factory-boy # Library for creating test fixtures, used in many tests |
No description provided.