📦 Build JS assets in CI and gitignore them

The npm 'package' and the django staticfiles assets are exclusively
to be built in the CI pipeline, and not kept in version control.

This keeps a single source of truth and prevents us from forgetting to
update the artifacts, at the cost of a little extra step for local
development.

.github/actions/build-js/action.yml

@@ -0,0 +1,39 @@
+---
+
+name: 'Build JS'
+description: 'Compile the TS source code'
+
+inputs:
+  npm-package:
+    description: Build NPM package
+    required: false
+    default: 'false'
+
+  django-staticfiles:
+    description: Bundle Django staticfiles
+    required: false
+    default: 'false'
+
+runs:
+  using: 'composite'
+
+  steps:
+
+    - uses: actions/setup-node@v4
+      with:
+        node-version-file: 'js/.nvmrc'
+        cache: npm
+        cache-dependency-path: js/package-lock.json
+
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Build NPM package
+      if: ${{ inputs.npm-package == 'true' }}
+      run: npm run build
+      working-directory: js
+
+    - name: Build Django assets package
+      if: ${{ inputs.django-staticfiles == 'true' }}
+      run: npm run build:django-static
+      working-directory: js

.github/workflows/ci.yml

@@ -17,18 +17,10 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: ./.github/actions/build-js
         with:
-          node-version-file: 'js/.nvmrc'
-          cache: npm
-          cache-dependency-path: js/package-lock.json
-
-      - name: Build TS
-        run: |
-          npm ci
-          npm run build
-          npm run build:django-static
-        working-directory: js
+          npm-package: 'true'
+          django-staticfiles: 'false'
 
   tests:
     runs-on: ubuntu-latest
@@ -77,6 +69,11 @@ jobs:
         with:
           python-version: '3.10'
 
+      - uses: ./.github/actions/build-js
+        with:
+          npm-package: 'false'
+          django-staticfiles: 'true'
+
       - name: Install dependencies
         run: |
           pip install tox tox-gh-actions pytest-playwright

.github/workflows/release.yml

@@ -26,6 +26,11 @@ jobs:
           python -m pip install -U pip
           python -m pip install -U setuptools twine wheel
 
+      - uses: ./.github/actions/build-js
+        with:
+          npm-package: 'true'
+          django-staticfiles: 'true'
+
       - name: Build package
         run: |
           python setup.py --version

.gitignore

@@ -24,5 +24,6 @@ reports/
 testapp/*.db
 
 # frontend tooling / builds
-js/lib/
 js/node_modules/
+js/lib/
+cookie_consent/static/cookie_consent/cookiebar.module.*

CONTRIBUTING.rst

@@ -46,6 +46,18 @@ You can then install the project with all the dev-tools:
 
    pip install -e .[tests,pep8,coverage,docs,release]
 
+Some frontend tooling is needed to:
+
+* NodeJS (for the version, see ``.nvmrc``, you can use ``nvm``)
+
+.. code-block:: bash
+
+    cd js
+    nvm use
+    npm install
+    npm run build:django-static
+    npm run build  # optional, but a nice check
+
 **Running the testapp as dev environment**
 
 In Django project's, you are typically expecting a ``manage.py`` file. This is less