Merge pull request #29 from ayacoo/quality

Quality

.editorconfig

@@ -0,0 +1,20 @@
+root = true
+
+[{*.rst,*.rst.txt}]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 3
+max_line_length = 80
+
+# MD-Files
+[*.md]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 4
+max_line_length = 80

.gitattributes

@@ -0,0 +1,23 @@
+/.Build/ export-ignore
+/.ddev/ export-ignore
+/.editorconfig export-ignore
+/.eslintignore export-ignore
+/.eslintrc.json export-ignore
+/.gitattributes export-ignore
+/.github/ export-ignore
+/.gitignore export-ignore
+/.gitlab/ export-ignore
+/.php-cs-fixer.php export-ignore
+/.phpstorm.meta.php export-ignore
+/.prettierrc.js export-ignore
+/Build/ export-ignore
+/Configuration/FunctionalTests.xml export-ignore
+/Configuration/UnitTests.xml export-ignore
+/Tests/ export-ignore
+/package.json export-ignore
+/phive.xml export-ignore
+/phpcs.xml export-ignore
+/phpstan-baseline.neon export-ignore
+/phpstan.neon export-ignore
+/stylelint.config.js export-ignore
+/tools/ export-ignore binary

.github/workflows/ci.yml

@@ -0,0 +1,157 @@
+---
+# This GitHub Actions workflow uses the same development tools that are also installed locally
+# via Composer or PHIVE and calls them using the Composer scripts.
+name: CI with Composer scripts
+on:
+  push:
+    branches:
+      - main
+      - quality
+  pull_request:
+permissions:
+  contents: read
+  packages: read
+jobs:
+  php-lint:
+    name: "PHP linter"
+    runs-on: ubuntu-22.04
+    steps:
+      - name: "Checkout"
+        uses: actions/checkout@v4
+      - name: "Install PHP"
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "${{ matrix.php-version }}"
+          coverage: none
+          tools: composer:v2
+      - name: "Show the Composer configuration"
+        run: "composer config --global --list"
+      - name: "Run PHP lint"
+        run: "composer ci:php:lint"
+    strategy:
+      fail-fast: false
+      matrix:
+        php-version:
+          - "8.1"
+          - "8.2"
+          - "8.3"
+  code-quality:
+    name: "Code quality checks"
+    runs-on: ubuntu-22.04
+    steps:
+      - name: "Checkout"
+        uses: actions/checkout@v4
+      - name: "Install PHP"
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "${{ matrix.php-version }}"
+          coverage: none
+          tools: composer:v2
+      - name: "Show Composer version"
+        run: "composer --version"
+      - name: "Show the Composer configuration"
+        run: "composer config --global --list"
+      - name: "Cache dependencies installed with composer"
+        uses: actions/cache@v4
+        with:
+          key: "php${{ matrix.php-version }}-composer-${{ hashFiles('**/composer.json') }}"
+          path: ~/.cache/composer
+          restore-keys: "php${{ matrix.php-version }}-composer-\n"
+      - name: "Install Composer dependencies"
+        run: "composer update --no-progress"
+      - name: "Run command"
+        run: "composer ci:${{ matrix.command }}"
+    strategy:
+      fail-fast: false
+      matrix:
+        command:
+          - "php:csfix"
+          - "php:sniff"
+          - "ts:lint"
+          - "xliff:lint"
+        php-version:
+          - "8.3"
+  unit-tests:
+    name: "Unit tests"
+    runs-on: ubuntu-22.04
+    needs: php-lint
+    steps:
+      - name: "Checkout"
+        uses: actions/checkout@v4
+      - name: "Install PHP"
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "${{ matrix.php-version }}"
+          coverage: none
+          tools: composer:v2
+      - name: "Show Composer version"
+        run: "composer --version"
+      - name: "Show the Composer configuration"
+        run: "composer config --global --list"
+      - name: "Cache dependencies installed with composer"
+        uses: actions/cache@v4
+        with:
+          key: "php${{ matrix.php-version }}-typo3${{ matrix.typo3-version }}-${{ matrix.composer-dependencies }}-composer-${{ hashFiles('**/composer.json') }}"
+          path: ~/.cache/composer
+          restore-keys: "php${{ matrix.php-version }}-typo3${{ matrix.typo3-version }}-${{ matrix.composer-dependencies }}-composer-\n"
+      - name: "Install TYPO3 Core"
+        env:
+          TYPO3: "${{ matrix.typo3-version }}"
+        run: |
+          composer require --no-ansi --no-interaction --no-progress --no-install typo3/cms-core:"$TYPO3"
+          composer show
+      - name: "Install highest dependencies with composer"
+        if: "matrix.composer-dependencies == 'highest'"
+        run: |
+          composer update --no-ansi --no-interaction --no-progress --with-dependencies
+          composer show
+      - name: "Run unit tests"
+        run: "composer ci:tests:unit"
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - typo3-version: "^12.4"
+            php-version: "8.1"
+            composer-dependencies: highest
+          - typo3-version: "^12.4"
+            php-version: "8.2"
+            composer-dependencies: highest
+          - typo3-version: "^12.4"
+            php-version: "8.3"
+            composer-dependencies: highest
+  functional-tests:
+    name: "Functional tests"
+    runs-on: ubuntu-22.04
+    needs: php-lint
+    strategy:
+      # This prevents cancellation of matrix job runs, if one/two already failed and let the
+      # rest matrix jobs be executed anyway.
+      fail-fast: false
+      matrix:
+        php: [ '8.1', '8.2', '8.3' ]
+        composerInstall: [ 'composerInstallHighest' ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install testing system
+        run: Build/Scripts/runTests.sh -t 12 -p ${{ matrix.php }} -s ${{ matrix.composerInstall }}
+
+      - name: Functional Tests with mariadb (min)
+        run: Build/Scripts/runTests.sh -t 12 -p ${{ matrix.php }} -d mariadb -i 10.3 -s functional
+
+      - name: Functional Tests with mariadb (max)
+        run: Build/Scripts/runTests.sh -t 12 -p ${{ matrix.php }} -d mariadb -i 10.11 -s functional
+
+      - name: Functional Tests with mysql (min/max)
+        run: Build/Scripts/runTests.sh -t 12 -p ${{ matrix.php }} -d mysql -j 8.0 -s functional
+
+      - name: Functional Tests with postgres (min)
+        run: Build/Scripts/runTests.sh -t 12 -p ${{ matrix.php }} -d postgres -k 10 -s functional
+
+      - name: Functional Tests with postgres (max)
+        run: Build/Scripts/runTests.sh -t 12 -p ${{ matrix.php }} -d postgres -k 16 -s functional
+
+      - name: Functional Tests with sqlite
+        run: Build/Scripts/runTests.sh -t 12 -p ${{ matrix.php }} -d sqlite -s functional

.gitignore

@@ -0,0 +1,11 @@
+/.Build
+.cache
+/composer.lock
+/composer.json.testing
+/.php_cs.cache
+/.php-cs-fixer.cache
+.DS_Store
+.idea/
+.fleet/
+/var/
+Build/testing-docker/.env