edx-cookiecutters icon indicating copy to clipboard operation
edx-cookiecutters copied to clipboard

ci: update actions

Open CodeWithEmad opened this issue 1 year ago • 9 comments

This will update all the actions as follows:

  • os: ubuntu-22.04
  • checkout: v4
  • setup-python: v5
  • python: 3.12

Close #460

CodeWithEmad avatar Jul 21 '24 21:07 CodeWithEmad

Thanks for the pull request, @CodeWithEmad!

What's next?

Please work through the following steps to get your changes ready for engineering review:

:radio_button: 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.

:radio_button: 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

:radio_button: 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.

:radio_button: 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

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

openedx-webhooks avatar Jul 21 '24 21:07 openedx-webhooks

Hey @CodeWithEmad, thank you for this contribution!

Let us know when it's ready for review.

itsjeyd avatar Jul 25 '24 09:07 itsjeyd

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?

CodeWithEmad avatar Jul 25 '24 10:07 CodeWithEmad

@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.

itsjeyd avatar Jul 26 '24 12:07 itsjeyd

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.

feanil avatar Jul 31 '24 15:07 feanil

@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,

https://github.com/openedx/edx-cookiecutters/blob/46948ba89cdbbd29c90f59ebf405cd867bfa05b3/cookiecutter-xblock/%7B%7Bcookiecutter.repo_name%7D%7D/Dockerfile#L2

which is still using Python 3.8, https://github.com/openedx/xblock-sdk/blob/1760448ebb073edba35be87d99f474d90d9421ac/Dockerfile#L19 I found this https://github.com/openedx/xblock-sdk/pull/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: https://github.com/openedx/edx-lint/pull/398

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

CodeWithEmad avatar Aug 01 '24 22:08 CodeWithEmad

@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.

feanil avatar Aug 06 '24 18:08 feanil

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

farhan avatar Aug 29 '24 10:08 farhan

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

CodeWithEmad avatar Sep 07 '24 06:09 CodeWithEmad

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

image

It's working as expected.

CodeWithEmad avatar Oct 15 '24 12:10 CodeWithEmad

@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?

itsjeyd avatar Oct 24 '24 08:10 itsjeyd

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

farhan avatar Oct 24 '24 08:10 farhan

@itsjeyd Looks like this is ready to merge!

CodeWithEmad avatar Oct 28 '24 09:10 CodeWithEmad

Thanks @CodeWithEmad !

kdmccormick avatar Oct 28 '24 15:10 kdmccormick