Skip to content

chore: update markdown dependency to allow newer versions#36735

Merged
feanil merged 5 commits intoopenedx:masterfrom
wgu-ram-chandra:issue-35271-unpin-markdown
May 27, 2025
Merged

chore: update markdown dependency to allow newer versions#36735
feanil merged 5 commits intoopenedx:masterfrom
wgu-ram-chandra:issue-35271-unpin-markdown

Conversation

@wgu-ram-chandra
Copy link
Contributor

Fixes: #35271

Description

This PR addresses a compatibility issue with the markdown library in edx-platform. Starting from version 3.4.0, markdown introduced several breaking changes, including:

  • Removal of the md_globals argument from extension hooks
  • Replacement of .add() with .register() for processor registration
  • Changes to the register() method's argument signature: now follows the format
    (<processor_instance>, <name>, <priority:int>)

These changes broke compatibility with dependencies such as openedx-django-wiki, which was still using the older Markdown API.

What’s Been Done

  • Identified that the AnchorTagExtension class in openedx-django-wiki was not compatible with markdown>=3.4.0.
  • Opened and merged a fix in the openedx-django-wiki repo: openedx/django-wiki#303
  • That fix has been included in version 3.1.1 of the openedx-django-wiki package.
  • With that update now available, this PR removes the markdown<3.4.0 constraint and allows markdown==3.8 (latest at time of writing), ensuring compatibility across both repos.

References

@openedx-webhooks
Copy link

Thanks for the pull request, @wgu-ram-chandra!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 17, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions May 17, 2025
@wgu-ram-chandra wgu-ram-chandra added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label May 17, 2025
@wgu-ram-chandra wgu-ram-chandra requested a review from feanil May 17, 2025 18:49
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions May 22, 2025
@feanil feanil merged commit 0721460 into openedx:master May 27, 2025
49 checks passed
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Contributions May 27, 2025
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

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

Labels

mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). 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.

4 participants

Comments