Skip to content

fix: use PEP 508 syntax for credentials-themes requirement - #3004

Open
GlugovGrGlib wants to merge 1 commit into
openedx:masterfrom
GlugovGrGlib:g-glugovskiy/fix-requirements-bot-egg-fragment
Open

fix: use PEP 508 syntax for credentials-themes requirement#3004
GlugovGrGlib wants to merge 1 commit into
openedx:masterfrom
GlugovGrGlib:g-glugovskiy/fix-requirements-bot-egg-fragment

Conversation

@GlugovGrGlib

@GlugovGrGlib GlugovGrGlib commented Sep 10, 2026

Copy link
Copy Markdown
Member

Description

The weekly automated "Upgrade Requirements" workflow has failed on every scheduled run since 2026-02-24 (last success: 2026-02-17, which produced #2959). Each run crashes in make upgrade on the very first pip-compile invocation:

pip._internal.exceptions.InvalidEggFragment: <InvalidEggFragment: invalid-egg-fragment>

The cause is this line in requirements/base.in:

git+https://github.com/openedx/credentials-themes.git@0.5.6#egg=edx_credentials_themes==0.5.6

An #egg= fragment may only contain a bare project name; the ==0.5.6 version specifier was never valid. Older pip only warned about it, but the workflow installs the latest pip, and pip >= 26 turned this long-deprecated pattern into a hard error — so pip-compile crashes at the parsing stage before resolving anything.

This PR switches the line to a PEP 508 direct reference
Verified with pip 26.1.2: the old line reproduces the exact InvalidEggFragment failure from the workflow logs, the new line parses correctly to edx_credentials_themes.

Impact

Once merged, the next scheduled bot run will succeed again and open a fresh requirements-upgrade PR. That will also supersede #2959, which is currently unmergeable because its pinned virtualenv==20.37.0 has since been deleted from PyPI.

Note: the workflow's failure notifications go to a 2U-internal OpsGenie address, which is likely why 6+ months of weekly failures went unnoticed.

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Sep 10, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @GlugovGrGlib!

This repository is currently maintained by @jajjibhai008.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

The legacy egg fragment with a version specifier
(#egg=edx_credentials_themes==0.5.6) was never valid and modern pip
(>=26) now rejects it with InvalidEggFragment instead of a warning.
This has crashed pip-compile in the weekly 'Upgrade Requirements'
workflow on every run since 2026-02-24, so the requirements bot has
been unable to open new upgrade PRs.

Switch to a PEP 508 direct reference so make upgrade works again.
@GlugovGrGlib
GlugovGrGlib force-pushed the g-glugovskiy/fix-requirements-bot-egg-fragment branch from a08cd36 to 4d3f59a Compare September 10, 2026 14:29

@e0d e0d left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Look good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: No status
Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

3 participants