Merge pull request #470 from maykinmedia/develop

v1.3 release

Author: alextreme

.github/workflows/ci.yml

@@ -58,6 +58,10 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y libxml2-dev libxmlsec1-dev libxmlsec1-openssl
           pip install -r requirements/dev.txt codecov
+          playwright install
+          playwright install msedge
+          playwright install-deps
+
       - name: Build frontend
         run: |
           npm ci
@@ -68,7 +72,7 @@ jobs:
           python src/manage.py collectstatic --noinput --link
           coverage run src/manage.py test src
         env:
-          DJANGO_SETTINGS_MODULE: open_inwoner.conf.dev
+          DJANGO_SETTINGS_MODULE: open_inwoner.conf.ci
           SECRET_KEY: dummy
           DB_USER: postgres
           DB_PASSWORD: ''

.github/workflows/code-quality.yml

@@ -49,6 +49,47 @@ jobs:
       - name: Run black
         run: |
           black --check --diff src
+
+  migrations:
+    name: Check for model changes not present in the migrations
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:12
+        env:
+          POSTGRES_HOST_AUTH_METHOD: trust
+        ports:
+          - 5432:5432
+        # Needed because the postgres container does not provide a healthcheck
+        options:
+          --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+      - name: Install system packages
+        run: |
+          sudo apt-get update \
+          && sudo apt-get install -y --no-install-recommends \
+            libgdal-dev \
+            gdal-bin
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libxml2-dev libxmlsec1-dev libxmlsec1-openssl
+          pip install -r requirements/dev.txt
+      - name: Run manage.py makemigrations --check --dry-run
+        run: |
+          src/manage.py makemigrations --check --dry-run
+        env:
+          DJANGO_SETTINGS_MODULE: open_inwoner.conf.dev
+          SECRET_KEY: dummy
+          DB_USER: postgres
+          DB_PASSWORD: ''
+
   prettier:
     name: Check code formatting with prettier
     runs-on: ubuntu-latest

INSTALL.rst

@@ -72,34 +72,45 @@ development machine.
        $ source env/bin/activate
        $ pip install -r requirements/dev.txt
 
-4. Install and build the frontend libraries:
+4. Run third-party install commands:
+
+   - Install the required browsers for `Playwright`_ end-to-end testing.
+
+   .. code-block:: bash
+
+       $ playwright install
+
+.. _Playwright: https://playwright.dev/python/
+
+5. Install and build the frontend libraries:
 
    .. code-block:: bash
 
        $ npm install
+       or as an alternative: npm ci --legacy-peer-deps
        $ npm run build
 
-5. Create the statics and database:
+6. Create the statics and database:
 
    .. code-block:: bash
 
        $ python src/manage.py collectstatic --link
        $ python src/manage.py migrate
 
-6. Create a superuser to access the management interface:
+7. Create a superuser to access the management interface:
 
    .. code-block:: bash
 
        $ python src/manage.py createsuperuser
 
-7. You can now run your installation and point your browser to the address
+8. You can now run your installation and point your browser to the address
    given by this command:
 
    .. code-block:: bash
 
        $ python src/manage.py runserver
 
-8. Create a .env file with database settings. See dotenv.example for an example.
+9. Create a .env file with database settings. See dotenv.example for an example.
 
         $ cp dotenv.example .env
 
@@ -134,6 +145,7 @@ When updating an existing installation:
        $ git pull
        $ pip install -r requirements/dev.txt
        $ npm install
+       or as an alternative: npm ci --legacy-peer-deps
        $ npm run build
 
 3. Update the statics and database: