Skip to content

Commit

Permalink
build: switch to new edx-platform asset build
Browse files Browse the repository at this point in the history
BREAKING CHANGE: `openedx-assets` is replaed with `npm run` subcommands.
For details, see the changelog entry, or the Open edX DEPR ticket:
openedx/edx-platform#31895
  • Loading branch information
kdmccormick committed Apr 18, 2024
1 parent 4c723df commit e359032
Show file tree
Hide file tree
Showing 7 changed files with 43 additions and 242 deletions.
24 changes: 24 additions & 0 deletions changelog.d/20240318_154804_kyle_assets_build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!--
Create a changelog entry for every new user-facing change. Please respect the following instructions:
- Indicate breaking changes by prepending an explosion 💥 character.
- Prefix your changes with either [Bugfix], [Improvement], [Feature], [Security], [Deprecation].
- You may optionally append "(by @<author>)" at the end of the line, where "<author>" is either one (just one)
of your GitHub username, real name or affiliated organization. These affiliations will be displayed in
the release notes for every release.
-->

- 💥[Feature] Within LMS and CMS containers, the `openedx-assets` command is replaced with `npm run` subcommands.
This will slightly reduce build time for edx-platform assets and themes.
It will also open up the door for more significant build time reductions in the future.
Here is a migration guide, where each command is to be run in the `lms` or `cms` container.
| **Before** | **After** |
| `openedx-assets build --env=prod ARGS` | `npm run build -- ARGS`
| `openedx-assets build --env=dev ARGS` | `npm run build-dev -- ARGS`
| `openedx-assets common --env=prod ARGS` | `npm run compile-sass -- --skip-themes ARGS`
| `openedx-assets common --env=dev ARGS` | `npm run compile-sass-dev -- --skip-themes ARGS`
| `openedx-assets webpack --env=prod ARGS` | `npm run webpack -- ARGS`
| `openedx-assets webpack --env=dev ARGS` | `npm run webpack-dev -- ARGS`
| `openedx-assets npm` | `npm run postinstall` (`npm clean-install` runs this automatically)
| `openedx-assets xmodule` | (no longer necessary)
| `openedx-assets collect ARGS` | `./manage.py lms collecstatic --noinput ARGS && ./manage.py cms collectstatic ARGS`
| `openedx-assets watch-themes ARGS` | `npm run watch-themes -- ARGS`
Empty file added docs/__init__.py
Empty file.
4 changes: 2 additions & 2 deletions docs/dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,9 @@ To open a python shell in the LMS or CMS, run::

You can then import edx-platform and django modules and execute python code.

To rebuild assets, you can use the ``openedx-assets`` command that ships with Tutor::
To rebuild assets, you can run the ``build-dev`` NPM script that comes with edx-plaform::

tutor dev run lms openedx-assets build --env=dev
tutor dev run lms npm run build-dev


.. _specialized for developer usage:
Expand Down
35 changes: 15 additions & 20 deletions tutor/templates/build/openedx/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -205,27 +205,22 @@ ENV PATH /openedx/bin:${PATH}

{{ patch("openedx-dockerfile-pre-assets") }}

# Collect production assets. By default, only assets from the default theme
# Build & collect production assets. By default, only assets from the default theme
# will be processed. This makes the docker image lighter and faster to build.
# Only the custom themes added to /openedx/themes will be compiled.
# Here, we don't run "paver update_assets" which is slow, compiles all themes
# and requires a complex settings file. Instead, we decompose the commands
# and run each one individually to collect the production static assets to
# /openedx/staticfiles.
ENV NO_PYTHON_UNINSTALL 1
ENV NO_PREREQ_INSTALL 1
# We need to rely on a separate openedx-assets command to accelerate asset processing.
# For instance, we don't want to run all steps of asset collection every time the theme
# is modified.
RUN openedx-assets xmodule \
&& openedx-assets npm \
&& openedx-assets webpack --env=prod \
&& openedx-assets common
RUN npm run postinstall # Postinstall artifacts are stuck in nodejs-requirements layer. Create them here too.
RUN npm run compile-sass -- --skip-themes
RUN npm run webpack

# Now that the default theme is built, build any custom themes in /openedx/themes.
COPY --chown=app:app ./themes/ /openedx/themes/
RUN openedx-assets themes \
&& openedx-assets collect --settings=tutor.assets \
# De-duplicate static assets with symlinks
&& rdfind -makesymlinks true -followsymlinks true /openedx/staticfiles/
RUN npm run compile-sass -- --skip-default --theme-dir /openedx/themes

# and finally, collect assets for the production image,
# de-duping assets with symlinks.
RUN ./manage.py lms collectstatic --noinput --settings=tutor.assets && \
./manage.py cms collectstatic --noinput --settings=tutor.assets && \
# De-duplicate static assets with symlinks \
rdfind -makesymlinks true -followsymlinks true /openedx/staticfiles/

# Create a data directory, which might be used (or not)
RUN mkdir /openedx/data
Expand Down Expand Up @@ -278,7 +273,7 @@ ENV PYTHONBREAKPOINT=ipdb.set_trace
# static assets, then production assets will be served instead.
RUN rm -r /openedx/staticfiles && \
mkdir /openedx/staticfiles && \
openedx-assets webpack --env=dev
npm run build-dev

{{ patch("openedx-dev-dockerfile-post-python-requirements") }}

Expand Down
218 changes: 0 additions & 218 deletions tutor/templates/build/openedx/bin/openedx-assets

This file was deleted.

2 changes: 1 addition & 1 deletion tutor/templates/dev/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ services:
# Additional service for watching theme changes
watchthemes:
<<: *openedx-service
command: openedx-assets watch-themes --env dev
command: npm run watch-sass
restart: unless-stopped

{% if RUN_ELASTICSEARCH and is_docker_rootless() %}
Expand Down
2 changes: 1 addition & 1 deletion tutor/templates/jobs/init/mounted-directories.sh
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ pip install -e .
npm clean-install

# Regenerate static assets.
openedx-assets build --env=dev
npm run build-dev

set -x
echo "Done setting up bind-mounted edx-platform."

0 comments on commit e359032

Please sign in to comment.