Skip to content

Commit

Permalink
test: check both dev and prod asset builds using npm run (openedx#34836)
Browse files Browse the repository at this point in the history
This switches the static asset check over from the deprecated
paver commands to the new 'npm run build' command. Doing so allows us
to check both the prod AND dev build, whereas before we were only
checking the prod build.

Please note that, as before, the "check" is only ensuring that the build
returns 0. It is not checking the contents of the build output.

Closes: openedx#34834
  • Loading branch information
kdmccormick authored and andrey-canon committed Nov 20, 2024
1 parent 7a0728d commit af6225a
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 7 deletions.
30 changes: 24 additions & 6 deletions .github/workflows/static-assets-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,21 +68,39 @@ jobs:
key: ${{ runner.os }}-pip-${{ hashFiles('requirements/edx/development.txt') }}
restore-keys: ${{ runner.os }}-pip-

- name: Install Required Python Dependencies
- name: Install Limited Python Deps for Build
run: |
make base-requirements
pip install -r requirements/edx/assets.txt
- name: Initiate Mongo DB Service
run: sudo systemctl start mongod

- name: Add node_modules bin to $Path
run: echo $GITHUB_WORKSPACE/node_modules/.bin >> $GITHUB_PATH

- name: Run Static Assets Check
- name: Check Dev Assets Build
env:
COMPREHENSIVE_THEMES_DIR: ./themes
run: |
npm clean-install --dev
npm run build-dev
- name: Check Prod Assets Build
env:
COMPREHENSIVE_THEMES_DIR: ./themes
run: |
npm clean-install
npm run build
- name: Install Full Python Deps for Collection
run: |
pip install -r requirements/edx/base.txt -e .
- name: Check Assets Collection
env:
LMS_CFG: lms/envs/minimal.yml
CMS_CFG: lms/envs/minimal.yml

DJANGO_SETTINGS_MODULE: lms.envs.production
run: |
paver update_assets lms --theme-dirs ./themes
paver update_assets cms --theme-dirs ./themes
./manage.py lms collectstatic --noinput
./manage.py cms collectstatic --noinput
2 changes: 1 addition & 1 deletion docs/references/static-assets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ skip this section.
First, ensure you have a Python enironment with all edx-platform dependencies
installed::

pip install -r requirements/edx/base.txt
pip install -r requirements/edx/base.txt -e .

Next, download localized versions of edx-platform assets. Under the hood, this
command uses the `Open edX Atlas`_ tool, which manages aggregated translations
Expand Down

0 comments on commit af6225a

Please sign in to comment.