Release 1.2.0

.docker/nginx.conf

@@ -7,7 +7,6 @@ events {
     worker_connections  1024;
 }
 
-
 http {
     proxy_temp_path /tmp/proxy_temp;
     client_body_temp_path /tmp/client_temp;
@@ -18,7 +17,7 @@ http {
     include       /etc/nginx/mime.types;
     default_type  application/octet-stream;
 
-    set_real_ip_from 172.16.0.0/8;
+    set_real_ip_from 172.16.0.0/16;
     real_ip_recursive on;
     real_ip_header X-Forwarded-For;
 

.docker/templates/default.conf.template

@@ -4,6 +4,13 @@ server {
 
     root ${NGINX_WEB_ROOT};
 
+    client_max_body_size ${NGINX_MAX_BODY_SIZE};
+
+    # This also needs to be set in the single server tag and not only in http.
+    set_real_ip_from 172.16.0.0/16;
+    real_ip_recursive on;
+    real_ip_header X-Forwarded-For;
+
     location / {
         # We are co-hosting with the legacy EventDB, so this app is hosted under '/api/v2/' (.env::APP_PATH_PREFIX)
         # This is configured for Symfony in both 'api_platform.prefix' and 'framework.assets.base_path'. However

.editorconfig

@@ -0,0 +1,24 @@
+# This file is copied from config/symfony/.editorconfig in https://github.com/itk-dev/devops_itkdev-docker.
+# Feel free to edit the file, but consider making a pull request if you find a general issue with the file.
+
+# EditorConfig is awesome: https://editorconfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+charset = utf-8
+end_of_line = LF
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{js,css,scss}]
+indent_size = 2
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[config/**/*.{yml,yaml}]
+indent_size = 4

.env

@@ -16,10 +16,11 @@
 
 COMPOSE_PROJECT_NAME=event-database-api-2
 COMPOSE_DOMAIN=event-database-api.local.itkdev.dk
+ITKDEV_TEMPLATE=symfony-6
 
 ###> symfony/framework-bundle ###
 APP_ENV=dev
-APP_SECRET=01324d73757787ffeba5f2f76cec1a28
+APP_SECRET=
 ###< symfony/framework-bundle ###
 
 ###> app ###

.env.dev

@@ -0,0 +1,4 @@
+
+###> symfony/framework-bundle ###
+APP_SECRET=4610ac31018b4685674121ea39d8a4c8
+###< symfony/framework-bundle ###

.env.test

@@ -4,3 +4,7 @@ APP_SECRET='$ecretf0rt3st'
 SYMFONY_DEPRECATIONS_HELPER=999999
 PANTHER_APP_ENV=panther
 PANTHER_ERROR_SCREENSHOT_DIR=./var/error-screenshots
+
+APP_API_KEYS='[
+  {"username": "test_user", "apikey": "test_api_key"}
+]'

.github/workflows/api-spec.yml

@@ -0,0 +1,114 @@
+on:
+  pull_request:
+
+name: API Spec review
+
+env:
+  COMPOSE_USER: root
+
+jobs:
+  api-spec:
+    runs-on: ubuntu-latest
+    name: Ensure committed API specification is up to date
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 2
+
+      # https://taskfile.dev/installation/#github-actions
+      - uses: go-task/setup-task@v1
+
+      - run: |
+          docker network create frontend
+          task --yes site:update
+
+      - name: Export API specification
+        run: |
+          task --yes api:spec:export
+
+      - name: Check for changes in specification
+        id: git-diff-spec
+        continue-on-error: true
+        run: git diff --diff-filter=ACMRT --exit-code public/spec.yaml
+
+      - name: Comment PR
+        if: steps.git-diff-spec.outcome == 'failure'
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          echo '## 🛑 Exported API specification file not up to date' > var/comment.md
+          echo '' >> var/comment.md
+          echo 'Please run `task api:spec:export` to export the API specification. Then commit and push the changes.' >> var/comment.md
+          gh pr comment ${{ github.event.pull_request.number }} --body-file var/comment.md --create-if-none --edit-last
+
+      - name: Fail job api spec is not up to date
+        if: steps.git-diff-spec.outcome == 'failure'
+        run: |
+          exit 1
+
+  detect-breaking-changes:
+    name: Detect breaking changes in API specification
+    runs-on: ubuntu-latest
+    needs: [api-spec]
+    steps:
+      - name: Check out BASE rev
+        uses: actions/checkout@v5
+        with:
+          ref: ${{ github.base_ref }}
+          path: base
+
+      - name: Check out HEAD rev
+        uses: actions/checkout@v5
+        with:
+          ref: ${{ github.head_ref }}
+          path: head
+
+      - name: Run OpenAPI Changed (from HEAD rev)
+        id: api-changed
+        continue-on-error: true
+        uses: docker://openapitools/openapi-diff:latest
+        with:
+          args: --fail-on-changed base/public/spec.yaml head/public/spec.yaml --markdown api-spec-changed.md
+
+      - name: Run OpenAPI Incompatible (from HEAD rev)
+        id: api-incompatible
+        continue-on-error: true
+        uses: docker://openapitools/openapi-diff:latest
+        with:
+          args: --fail-on-incompatible base/public/spec.yaml head/public/spec.yaml --markdown api-spec-incompatible.md
+
+      - name: Comment PR with no changes
+        if: steps.api-changed.outcome == 'success' && steps.api-incompatible.outcome == 'success'
+        working-directory: head
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh pr comment ${{ github.event.pull_request.number }} --body "✅ **No changes detected in API specification**" --create-if-none --edit-last
+
+      - name: Comment PR with non-breaking changes
+        if: steps.api-changed.outcome == 'failure' && steps.api-incompatible.outcome == 'success'
+        working-directory: head
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          echo "## ⚠️ Non-Breaking changes detected in API specification" > ../comment.md
+          echo "" >> ../comment.md
+          cat ../api-spec-changed.md >> ../comment.md
+          gh pr comment ${{ github.event.pull_request.number }} --body-file ../comment.md --create-if-none --edit-last
+
+      - name: Comment PR with breaking changes
+        if: steps.api-incompatible.outcome == 'failure'
+        working-directory: head
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          echo "## 🛑 Breaking changes detected in API specification" > ../comment.md
+          echo "" >> ../comment.md
+          cat ../api-spec-incompatible.md >> ../comment.md
+          gh pr comment ${{ github.event.pull_request.number }} --body-file ../comment.md --create-if-none --edit-last
+
+      - name: Fail if breaking changes detected
+        if: steps.api-incompatible.outcome == 'failure'
+        run: |
+          exit 1

.github/workflows/build_release.yml

@@ -1,7 +1,7 @@
 on:
   push:
     tags:
-      - '*.*.*'
+      - "*.*.*"
 
 name: Create Github Release
 
@@ -16,7 +16,7 @@ jobs:
       APP_ENV: prod
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Composer install
         run: |

.github/workflows/changelog.yaml

@@ -0,0 +1,29 @@
+# Do not edit this file! Make a pull request on changing
+# github/workflows/changelog.yaml in
+# https://github.com/itk-dev/devops_itkdev-docker if need be.
+
+### ### Changelog
+###
+### Checks that changelog has been updated
+
+name: Changelog
+
+on:
+  pull_request:
+
+jobs:
+  changelog:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 2
+
+      - name: Git fetch
+        run: git fetch
+
+      - name: Check that changelog has been updated.
+        run: git diff --exit-code origin/${{ github.base_ref }} -- CHANGELOG.md && exit 1 || exit 0

.github/workflows/composer.yaml

@@ -0,0 +1,80 @@
+# Do not edit this file! Make a pull request on changing
+# github/workflows/composer.yaml in
+# https://github.com/itk-dev/devops_itkdev-docker if need be.
+
+### ### Composer
+###
+### Validates composer.json and checks that it's normalized.
+###
+### #### Assumptions
+###
+### 1. A docker compose service named `phpfpm` can be run and `composer` can be
+###    run inside the `phpfpm` service.
+### 2. [ergebnis/composer-normalize](https://github.com/ergebnis/composer-normalize)
+###    is a dev requirement in `composer.json`:
+###
+###    ``` shell
+###    docker compose run --rm phpfpm composer require --dev ergebnis/composer-normalize
+###    ```
+###
+###    Normalize `composer.json` by running
+###
+###    ``` shell
+###    docker compose run --rm phpfpm composer normalize
+###    ```
+
+name: Composer
+
+env:
+  COMPOSE_USER: root
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - develop
+
+jobs:
+  composer-validate:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Create docker network
+        run: |
+          docker network create frontend
+
+      - run: |
+          docker compose run --rm phpfpm composer validate --strict
+
+  composer-normalized:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Create docker network
+        run: |
+          docker network create frontend
+
+      - run: |
+          docker compose run --rm phpfpm composer install
+          docker compose run --rm phpfpm composer normalize --dry-run
+
+  composer-audit:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Create docker network
+        run: |
+          docker network create frontend
+
+      - run: |
+          docker compose run --rm phpfpm composer audit

.github/workflows/markdown.yaml

@@ -0,0 +1,44 @@
+# Do not edit this file! Make a pull request on changing
+# github/workflows/markdown.yaml in
+# https://github.com/itk-dev/devops_itkdev-docker if need be.
+
+### ### Markdown
+###
+### Lints Markdown files (`**/*.md`) in the project.
+###
+### [markdownlint-cli configuration
+### files](https://github.com/igorshubovych/markdownlint-cli?tab=readme-ov-file#configuration),
+### `.markdownlint.jsonc` and `.markdownlintignore`, control what is actually
+### linted and how.
+###
+### #### Assumptions
+###
+### 1. A docker compose service named `markdownlint` for running `markdownlint`
+###    (from
+###    [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli))
+###    exists.
+
+name: Markdown
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - develop
+
+jobs:
+  markdown-lint:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Create docker network
+        run: |
+          docker network create frontend
+
+      - run: |
+          docker compose run --rm markdownlint markdownlint '**/*.md'