Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Python 3.8 dropped and support for 3.12 added #471

Merged
merged 6 commits into from
Oct 28, 2024

Conversation

CodeWithEmad
Copy link
Member

@CodeWithEmad CodeWithEmad commented Jul 21, 2024

This will update all the actions as follows:

  • checkout: v4
  • setup-python: v5
  • python: 3.12

Also, Python 3.12 added everywhere.

Close #460 #485

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 21, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Jul 21, 2024

Thanks for the pull request, @CodeWithEmad!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently unmaintained.

To get help with finding a technical reviewer, tag the community contributions project manager for this PR in a comment and let them know that your changes are ready for review:

  1. On the right-hand side of the PR, find the Contributions project, click the caret in the top right corner to expand it, and check the "Primary PM" field for the name of your PM.
  2. Find their GitHub handle here.

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.

@itsjeyd
Copy link

itsjeyd commented Jul 25, 2024

Hey @CodeWithEmad, thank you for this contribution!

Let us know when it's ready for review.

@CodeWithEmad
Copy link
Member Author

For sure, @itsjeyd.
I will worl on it in the coming days. In the meanwhile, I wanted to ask about the current state of tests. Should we have the CI actions run only on Python 3.12 or we have to have 3.8 also?

@itsjeyd
Copy link

itsjeyd commented Jul 26, 2024

@CodeWithEmad Sounds good!

In the meanwhile, I wanted to ask about the current state of tests. Should we have the CI actions run only on Python 3.12 or we have to have 3.8 also?

I'll forward this question to @feanil.

@feanil
Copy link
Contributor

feanil commented Jul 31, 2024

We should continue to run the testing with both Python 3.11 and 3.12 but dropping 3.8 is totally fine across all openedx projects.

@CodeWithEmad CodeWithEmad force-pushed the fix/update-actions branch 2 times, most recently from 7e6c865 to 9e0156e Compare August 1, 2024 22:25
@CodeWithEmad
Copy link
Member Author

@feanil I'm working on dropping Python 3.8 here, but there are a couple of blockers here:
the dev image is using the xblock-sdk image,

which is still using Python 3.8, https://github.com/openedx/xblock-sdk/blob/1760448ebb073edba35be87d99f474d90d9421ac/Dockerfile#L19
I found this openedx/xblock-sdk#350, but it's stuck for a while.
Also, lint jobs are failing since there's no pkg_resources and edx-lint is still using it: openedx/edx-lint#398

https://github.com/openedx/edx-cookiecutters/actions/runs/10206678813/job/28240034237?pr=471

@feanil
Copy link
Contributor

feanil commented Aug 6, 2024

@CodeWithEmad I'll see if we can land the xblock-sdk issue first then we can update that as a part of the PR here.

@farhan
Copy link

farhan commented Aug 29, 2024

Issue will be fixed in openedx/xblock-sdk#397
Hopefully this PR will be unblocked to work on once its merged and docker image pushed.
FYI: @CodeWithEmad

@CodeWithEmad
Copy link
Member Author

Thanks, @farhan. I'll continue this in the coming weeks.

Remove unnecessary branch specification for workflow_dispatch event
All of the functionalities in xblockutils is moved to xblock.utils inside XBlock pakcage
@CodeWithEmad CodeWithEmad force-pushed the fix/update-actions branch 2 times, most recently from b9e12fd to a364d9b Compare October 6, 2024 08:06
@CodeWithEmad CodeWithEmad marked this pull request as ready for review October 6, 2024 09:14
@CodeWithEmad CodeWithEmad changed the title ci: update actions fix: Python 3.8 dropped and support for 3.12 added Oct 6, 2024
@CodeWithEmad CodeWithEmad mentioned this pull request Oct 6, 2024
pkg_resources is available in python 3.12 only if setuptools is explicitly installed, which is not always the case.
* dev.stop: Stop the running container
* dev.migrate: Run migrations in the container
* dev.logs: View logs from the container
* dev.exec: Execute to the dev container
@CodeWithEmad CodeWithEmad force-pushed the fix/update-actions branch 4 times, most recently from 0e1e1c0 to 146c66c Compare October 8, 2024 09:11
Copy link

@farhan farhan left a comment

Choose a reason for hiding this comment

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

Good work @CodeWithEmad
I will suggest to create an example xblock using the cookie cutter, run it on xblock-sdk or edx-platform and make sure example xblock is rendering/working fine.

@itsjeyd itsjeyd added the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Oct 11, 2024
@CodeWithEmad
Copy link
Member Author

@farhan I created an XBlock from the cookiecutter and installed it in the xblock-sdk as well.

image

It's working as expected.

@itsjeyd itsjeyd requested a review from farhan October 17, 2024 07:42
@itsjeyd itsjeyd added waiting for eng review PR is ready for review. Review and merge it, or suggest changes. and removed waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels Oct 17, 2024
Copy link

@farhan farhan left a comment

Choose a reason for hiding this comment

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

Good work ⭐

@farhan farhan removed the request for review from irtazaakram October 17, 2024 07:49
@itsjeyd itsjeyd removed the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Oct 24, 2024
@itsjeyd
Copy link

itsjeyd commented Oct 24, 2024

@CodeWithEmad Looks like this PR is ready to merge! 🚀

@farhan Do you have the necessary permissions or will we need to ask Axim to merge the changes?

@farhan
Copy link

farhan commented Oct 24, 2024

I don't have merging rights
@CodeWithEmad Do you have merging rights?
or @kdmccormick @feanil can help

Copy link
Member

@irtazaakram irtazaakram left a comment

Choose a reason for hiding this comment

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

Just a few minor tweaks, but overall, it looks great!

@CodeWithEmad CodeWithEmad force-pushed the fix/update-actions branch 2 times, most recently from 2b146c0 to 0bd5a70 Compare October 27, 2024 09:46
@CodeWithEmad
Copy link
Member Author

@itsjeyd Looks like this is ready to merge!

Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

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

I have not reviewed line-by-line, but I trust the Aximprovement team's reviews here.

@feanil , for context, Emad and I spoke about whether we need to put 3.11 testing back in place for the cookie-cut result repo. My sense was that we are so close to being on 3.12 project-wide that it would be a waste of effort and CI cycles to test both versions for new packages, especially since the services running 3.11 will transitively test much of the package code via its own 3.11 CI checks. If you disagree LMK and we can put back 3.11 testing in a quick followup.

@kdmccormick kdmccormick merged commit a3edb30 into openedx:master Oct 28, 2024
5 checks passed
@kdmccormick
Copy link
Member

Thanks @CodeWithEmad !

@CodeWithEmad CodeWithEmad deleted the fix/update-actions branch October 28, 2024 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

Update edx-cookie-cutter
8 participants