Merge pull request #147 from django-commons/chore/automate-npm-package-publishing

Automate publishing of Python and NPM packages

Author: sergei-maertens

.github/workflows/ci.yml

@@ -81,3 +81,54 @@ jobs:
         uses: codecov/codecov-action@v3
         with:
           directory: reports/
+
+
+  publish:
+    name: Publish packages to PyPI and NPM
+    runs-on: ubuntu-latest
+    needs:
+      - tests
+      - e2e_tests
+
+    if: github.repository == 'django-commons/django-cookie-consent' && github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+
+    environment:
+      name: release
+      url: https://pypi.org/project/django-cookie-consent/
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: 'js/.nvmrc'
+          cache: npm
+          registry-url: 'https://registry.npmjs.org'
+
+      # Required to ensure the build artifacts are in the packages.
+      - uses: ./.github/actions/build-js
+        with:
+          npm-package: 'true'
+          django-staticfiles: 'true'
+
+      - name: Build sdist and wheel
+        run: |
+          pip install build --upgrade
+          python -m build
+
+      # TODO: enable verified publishing!
+      - name: Publish a Python distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: Publish NPM package
+        run: |
+          version=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
+          npm publish --new-version="$version"
+        working-directory: js
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/code_quality.yml

@@ -29,3 +29,4 @@ jobs:
       - run: tox
         env:
           TOXENV: ${{ matrix.toxenv }}
+          FORCE_COLOR: '1'

.github/workflows/release.yml

@@ -13,6 +13,7 @@ Manage cookie information and let visitors give or reject consent for them.
 ![Supported python versions](https://img.shields.io/pypi/pyversions/django-cookie-consent)
 ![Supported Django versions](https://img.shields.io/pypi/djversions/django-cookie-consent)
 [![PyPI version][badge:pypi]][pypi]
+[![NPM version][badge:npm]][npm]
 
 **Features**
 
@@ -44,3 +45,5 @@ from the `docs` directory in this repository.
 [badge:docs]: https://readthedocs.org/projects/django-cookie-consent/badge/?version=latest
 [pypi]: https://pypi.org/project/django-cookie-consent/
 [badge:pypi]: https://img.shields.io/pypi/v/django-cookie-consent.svg
+[npm]: https://www.npmjs.com/package/django-cookie-consent
+[badge:npm]: https://img.shields.io/npm/v/django-cookie-consent

README.md

@@ -237,3 +237,7 @@
 
 # Documents to append as an appendix to all manuals.
 texinfo_appendices = []
+
+linkcheck_ignore = [
+    r"https://(www\.)?npmjs\.com.*",  # IP/UA blocking...
+]

docs/conf.py

@@ -1 +1 @@
-v20
+v24

js/.nvmrc

@@ -6,6 +6,8 @@ The cookiebar module is shipped in the Python package itself and available throu
 django's staticfiles mechanism. This package is aimed at users wishing to include the
 assets in their own Javascript bundle through webpack/vite/...
 
+[![PyPI version][badge:pypi]][pypi]
+
 ## Installation
 
 ```bash
@@ -45,3 +47,6 @@ in the Python package:
 ```bash
 npm run build:django-static
 ```
+
+[pypi]: https://pypi.org/project/django-cookie-consent/
+[badge:pypi]: https://img.shields.io/pypi/v/django-cookie-consent.svg