Skip to content

Conversation

@wgu-taylor-payne
Copy link
Contributor

Description

Remove pin on django-simple-history version 3.4.0 in constraints file to allow newer versions of the package. This allows for compatibility with newer versions of Django.

There are no breaking changes introduced in versions 3.5.0 through 3.8.0 (see releases). Version 3.8.0 supports Django 4.2 through 5.2 and Python 3.9 through 3.13.

Supporting information

Resolves #36747. This PR is a part of the effort to add Django 5.2 support.

The pin for django-simple-history to 3.4.0 was introduced in this PR. I didn't find any further explanation for the pin.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 30, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @wgu-taylor-payne!

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.

@wgu-taylor-payne wgu-taylor-payne self-assigned this May 30, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions May 30, 2025
@wgu-taylor-payne wgu-taylor-payne added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label May 30, 2025
@wgu-taylor-payne wgu-taylor-payne changed the title chore: remove version constraint on django-simple-history and update to 3.8.0 chore: remove version constraint on django-simple-history May 30, 2025
@wgu-taylor-payne wgu-taylor-payne force-pushed the update-django-simple-history branch from f551bc6 to b6314f8 Compare May 30, 2025 14:22
…to 3.8.0

Remove pin on 3.4.0 to allow newer versions of the package.
@wgu-taylor-payne wgu-taylor-payne force-pushed the update-django-simple-history branch from b6314f8 to 4f58823 Compare May 30, 2025 14:24
@wgu-taylor-payne wgu-taylor-payne requested a review from a team May 30, 2025 15:56
Comment on lines -32 to -34
# Date: 2024-02-02
# incremental upgrade
django-simple-history==3.4.0
Copy link
Contributor

Choose a reason for hiding this comment

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

This seems reasonable. The comment isn't really clear about why it was added. @iamsobanjaved - can you shed any light? Can we move forward with this without causing issues?

Copy link
Contributor

Choose a reason for hiding this comment

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

It was added when we were a few versions behind on django-simple-history, and we plan to upgrade incrementally, version by version.

@robrap robrap requested a review from iamsobanjaved May 30, 2025 16:27
@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Jun 3, 2025
Copy link
Contributor

@feanil feanil left a comment

Choose a reason for hiding this comment

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

I think it's fine to put this on the regular upgrade path. If we run into major version changes, we should review them along with any other regular requirements upgrades. Pinning it here just makes it more likely that we'll fall behind.

@feanil feanil merged commit a01f4b1 into openedx:master Jun 4, 2025
49 checks passed
@github-project-automation github-project-automation bot moved this from In Eng Review to Done in Contributions Jun 4, 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.

1 similar comment
@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.

django-simple-history needs updated version for django5.2 support

6 participants