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

Paver Removal 3/3 #34832

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

kdmccormick
Copy link
Member

@kdmccormick kdmccormick commented May 21, 2024

Description

This fully removes Paver from edx-platform and updates some documentation accordingly. See individual commits for more detail.

  • BREAKING CHANGE: Removes all remaining Paver commands including
    pavelib/prereqs.py:* and pavelib/assets.py:*.

  • BREAKING CHANGE: Removes ./manage.py [lms|cms] compile_sass, which
    was just a wrapper around Paver commands.

  • BREAKING CHANGE: Removes paver.txt. Operators should install testing.txt
    instead.

  • BREAKING CHANGE: Removes libsass from requirements/edx/base.txt.
    Operators will need to install requirements/edx/assets.txt in order to
    compile Sass.

Note that the build!: rejigger npm run test commands commit is technically a breaking change, but those commands were first added a week ago and were not documented, so I don't feel like we need to raise this as BREAKING CHANGE.

Supporting information

This plan has been accepted and communicated via the DEPR process:

Previous PRs (blocking this one):

Testing instructions

I built the Tutor openedx and openedx-dev images with this branch. I smoke tested LMS and CMS in both modes, and ensure that I could toggle between Indigo and the default theme.

I inspected the JS Test logs to ensure that we're still running 6 test suites (jest, cms-vanilla, cms-require, xmodule-vanilla, common-vanilla, common-require).

Finally, you can check out the updated edx-platform testing guide here: https://github.com/kdmccormick/edx-platform/blob/kdmccormick/paver-rm-3/docs/concepts/testing/testing.rst. Using Tutor, I installed the tutor-contrib-legacy-js plugin (from a branch: https://github.com/kdmccormick/openedx-tutor-plugins/tree/kdmccormick/test-legacy-js/plugins/tutor-contrib-test-legacy-js) and ran JS tests locally.

@kdmccormick
Copy link
Member Author

@feanil If you have some spare cycles to review this, would you like do the honors?

kdmccormick and others added 6 commits December 17, 2024 15:30
BREAKING CHANGE: Removes all remaining Paver commands including
`pavelib/prereqs.py:*` and `pavelib/assets.py:*`.

BREAKING CHANGE: Removes `./manage.py [lms|cms] compile_sass`, which
was just a wrapper around Paver commands.

BREAKING CHANGE: Removes paver.txt. Operators should install testing.txt
instead.

Part of: openedx#34467
There are three packages which edx-platform needs in order to run which
were being installed transitively via paver.in. Since we are removing
paver.in, these dependencies need to be transferred into kernel.in:

* psutil
* pymemcache
* wrapt

Part of: openedx#34467
BREAKING CHANGE: Removes libsass from requirements/edx/base.txt.
Operators will need to install requirements/edx/assets.txt in order to
compile Sass.

Commit generated by workflow `kdmccormick/edx-platform/.github/workflows/compile-python-requirements.yml@refs/heads/master`
This is technically a breaking change, but these commands were added a
week ago and were not yet documented, so I'm not worried about breaking
anyone's workflow with this commit.
@kdmccormick kdmccormick force-pushed the kdmccormick/paver-rm-3 branch from 0be6951 to 2aa06f4 Compare December 17, 2024 20:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant