Merge pull request #340 from phpDocumentor/modernize_ci

Upgrade ci to standardized pipeline

.github/dependabot.yml

@@ -1,11 +1,12 @@
 version: 2
 updates:
-- package-ecosystem: composer
+  - package-ecosystem: "composer"
-  directory: "/"
+    directory: "/"
-  schedule:
+    schedule:
-    interval: weekly
+      interval: "daily"
-  open-pull-requests-limit: 10
+    open-pull-requests-limit: 10
-- package-ecosystem: "github-actions"
+
-  directory: "/"
+  - package-ecosystem: "github-actions"
-  schedule:
+    directory: "/"
-    interval: "weekly"
+    schedule:
+      interval: "weekly"

.github/workflows/integrate.yaml

@@ -0,0 +1,60 @@
+# https://docs.github.com/en/actions
+
+name: "Integrate"
+
+on: # yamllint disable-line rule:truthy
+  push:
+    branches:
+      - "5.x"
+  pull_request: null
+  # Allow manually triggering the workflow.
+  workflow_dispatch: null
+
+jobs:
+  code-coverage:
+    name: "Code Coverage"
+    uses: "phpDocumentor/.github/.github/workflows/code-coverage.yml@main"
+    with:
+      composer-root-version: "5.x-dev"
+
+  coding-standards:
+    name: "Coding Standards"
+    uses: "phpDocumentor/.github/.github/workflows/[email protected]"
+    with:
+      composer-root-version: "5.x-dev"
+
+  dependency-analysis:
+    name: "Dependency analysis"
+    uses: "phpDocumentor/.github/.github/workflows/[email protected]"
+    with:
+      composer-root-version: "5.x-dev"
+
+  lint-root:
+    name: "Lint root"
+    uses: "phpDocumentor/.github/.github/workflows/lint.yml@main"
+    with:
+      composer-options: "--no-check-publish --ansi"
+
+  static-analysis:
+    name: "Static analysis"
+    uses: "phpDocumentor/.github/.github/workflows/[email protected]"
+    with:
+      php-extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter, fileinfo, pcntl, posix"
+      composer-root-version: "5.x-dev"
+
+  unit-tests:
+    name: "Unit test"
+    uses: "phpDocumentor/.github/.github/workflows/[email protected]"
+    with:
+      composer-root-version: "5.x-dev"
+      php-versions: "['7.4', '8.0', '8.1', '8.2']"
+
+  bc_check:
+    name: "BC Check"
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v3"
+      - name: "fetch tags"
+        run: "git fetch --depth=1 origin +refs/tags/*:refs/tags/*"
+      - name: "BC Check"
+        uses: "docker://nyholm/roave-bc-check-ga"

.github/workflows/push.yml

@@ -1,216 +0,0 @@
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-  # Allow manually triggering the workflow.
-  workflow_dispatch:
-name: Qa workflow
-env:
-  phiveGPGKeys: 4AA394086372C20A,D2CCAC42F6295E7D,E82B2FB314E9906E,8A03EA3B385DBAA1
-jobs:
-  setup:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: composer
-        uses: docker://composer
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          args: install --no-interaction --prefer-dist --optimize-autoloader
-
-      - name: composer-require-checker
-        uses: docker://phpga/composer-require-checker-ga
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          args: check --config-file ./composer-require-config.json composer.json
-
-  phpunit-with-coverage:
-    runs-on: ubuntu-latest
-    name: Unit tests
-    needs: setup
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: composer
-        uses: docker://composer
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          args: install --no-interaction --prefer-dist --optimize-autoloader
-
-      - name: PHPUnit
-        uses: docker://phpdoc/phpunit-ga:latest
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Quick check code coverage level
-        run: php tests/coverage-checker.php 91
-
-  phpunit:
-    name: Unit tests for PHP version ${{ matrix.php-versions }} on ${{ matrix.operating-system }}
-    runs-on: ${{ matrix.operating-system }}
-    strategy:
-      fail-fast: false
-      matrix:
-        dependencies:
-          - highest
-          - locked
-          - lowest
-        operating-system:
-          - ubuntu-latest
-          - windows-latest
-          - macOS-latest
-        php-versions: ['7.2', '7.3', '7.4', '8.0', '8.1']
-    env:
-      extensions: mbstring
-      key: cache-v1 # can be any string, change to clear the extension cache.
-
-    needs:
-      - setup
-      - phpunit-with-coverage
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Setup cache environment
-        id: cache-env
-        uses: shivammathur/cache-extensions@v1
-        with:
-          php-version: ${{ matrix.php-versions }}
-          extensions: ${{ env.extensions }}
-          key: ${{ env.key }}
-
-      - name: Cache extensions
-        uses: actions/cache@v3
-        with:
-          path: ${{ steps.cache-env.outputs.dir }}
-          key: ${{ steps.cache-env.outputs.key }}
-
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-versions }}
-          extensions: ${{ env.extensions }}
-          ini-values: memory_limit=2G, display_errors=On, error_reporting=-1
-          tools: phive
-
-      - name: Install PHAR dependencies
-        env:
-          GITHUB_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: phive --no-progress install --copy --trust-gpg-keys ${{ env.phiveGPGKeys }} --force-accept-unsigned
-
-      - name: Install phpunit 8 for php 7.2
-        if: matrix.php-versions == '7.2'
-        env:
-          GITHUB_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: phive --no-progress install --copy --trust-gpg-keys ${{ env.phiveGPGKeys }} phpunit:^8.5
-
-      - name: Install Composer ${{ matrix.dependencies }} dependencies & cache dependencies
-        uses: "ramsey/composer-install@v2"
-        with:
-          composer-options: --optimize-autoloader
-          dependency-versions: ${{ matrix.dependencies }}
-
-      - name: Run PHPUnit
-        run: php tools/phpunit
-
-  codestyle:
-    runs-on: ubuntu-latest
-    needs: [setup, phpunit]
-    steps:
-      - uses: actions/checkout@v3
-      - name: Restore/cache vendor folder
-        uses: actions/cache@v3
-        with:
-          path: vendor
-          key: all-build-${{ hashFiles('**/composer.lock') }}
-          restore-keys: |
-            all-build-${{ hashFiles('**/composer.lock') }}
-            all-build-
-      - name: Code style check
-        uses: phpDocumentor/coding-standard@latest
-        with:
-          args: -s
-
-  phpstan:
-    runs-on: ubuntu-latest
-    needs: [setup, phpunit]
-    steps:
-      - uses: actions/checkout@v3
-      - name: composer
-        uses: docker://composer
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          args: install --no-interaction --prefer-dist --optimize-autoloader
-
-      - name: PHPStan
-        uses: phpDocumentor/[email protected]
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          args: analyse src --configuration phpstan.neon
-
-  psalm:
-    name: Psalm
-    runs-on: ${{ matrix.operating-system }}
-    strategy:
-      matrix:
-        operating-system:
-          - ubuntu-latest
-        php-versions: ['7.2']
-    env:
-      extensions: mbstring
-      key: cache-v1 # can be any string, change to clear the extension cache.
-
-    needs:
-      - setup
-      - phpunit
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Setup cache environment
-        id: cache-env
-        uses: shivammathur/cache-extensions@v1
-        with:
-          php-version: ${{ matrix.php-versions }}
-          extensions: ${{ env.extensions }}
-          key: ${{ env.key }}
-
-      - name: Cache extensions
-        uses: actions/cache@v3
-        with:
-          path: ${{ steps.cache-env.outputs.dir }}
-          key: ${{ steps.cache-env.outputs.key }}
-
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-versions }}
-          extensions: ${{ env.extensions }}
-          ini-values: memory_limit=2G, display_errors=On, error_reporting=-1
-
-      - name: Install Composer dependencies & cache dependencies
-        uses: "ramsey/composer-install@v2"
-        with:
-          composer-options: --optimize-autoloader
-
-      - name: Run psalm
-        run: vendor/bin/psalm.phar --output-format=github
-
-
-  bc_check:
-    name: BC Check
-    runs-on: ubuntu-latest
-    needs: [setup, phpunit]
-    steps:
-      - uses: actions/checkout@v3
-      - name: fetch tags
-        run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
-      - name: BC Check
-        uses: docker://nyholm/roave-bc-check-ga

.yamllint.yaml

@@ -0,0 +1,65 @@
+extends: "default"
+
+ignore: |
+  .build/
+  .notes/
+  vendor/
+rules:
+  braces:
+    max-spaces-inside-empty: 0
+    max-spaces-inside: 1
+    min-spaces-inside-empty: 0
+    min-spaces-inside: 1
+  brackets:
+    max-spaces-inside-empty: 0
+    max-spaces-inside: 0
+    min-spaces-inside-empty: 0
+    min-spaces-inside: 0
+  colons:
+    max-spaces-after: 1
+    max-spaces-before: 0
+  commas:
+    max-spaces-after: 1
+    max-spaces-before: 0
+    min-spaces-after: 1
+  comments:
+    ignore-shebangs: true
+    min-spaces-from-content: 1
+    require-starting-space: true
+  comments-indentation: "enable"
+  document-end:
+    present: false
+  document-start:
+    present: false
+  indentation:
+    check-multi-line-strings: false
+    indent-sequences: true
+    spaces: 2
+  empty-lines:
+    max-end: 0
+    max-start: 0
+    max: 1
+  empty-values:
+    forbid-in-block-mappings: true
+    forbid-in-flow-mappings: true
+  hyphens:
+    max-spaces-after: 2
+  key-duplicates: "enable"
+  key-ordering: "disable"
+  line-length: "disable"
+  new-line-at-end-of-file: "enable"
+  new-lines:
+    type: "unix"
+  octal-values:
+    forbid-implicit-octal: true
+  quoted-strings:
+    quote-type: "double"
+  trailing-spaces: "enable"
+  truthy:
+    allowed-values:
+      - "false"
+      - "true"
+
+yaml-files:
+  - "*.yaml"
+  - "*.yml"

Makefile

@@ -1,37 +1,43 @@
-.PHONY: install-phive
+.PHONY: help
-install-phive:
+help: ## Displays this list of targets with descriptions
-	mkdir tools; \
+	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}'
-	wget -O tools/phive.phar https://phar.io/releases/phive.phar; \
-	wget -O tools/phive.phar.asc https://phar.io/releases/phive.phar.asc; \
-	gpg --keyserver pool.sks-keyservers.net --recv-keys 0x9D8A98B29B2D5D79; \
-	gpg --verify tools/phive.phar.asc tools/phive.phar; \
-	chmod +x tools/phive.phar
 
-.PHONY: setup
+.PHONY: code-style
-setup: install-phive
+code-style:
-	docker run -it --rm -v${PWD}:/opt/project -w /opt/project phpdoc/phar-ga:latest php tools/phive.phar install --force-accept-unsigned
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project phpdoc/phpcs-ga:latest -d memory_limit=1024M -s
 
-.PHONY: phpcs
+.PHONY: fix-code-style
-phpcs:
+fix-code-style:
-	docker run -it --rm -v${PWD}:/opt/project -w /opt/project phpdoc/phpcs-ga:latest -s
-
-.PHONY: phpcbf
-phpcbf:
 	docker run -it --rm -v${PWD}:/opt/project -w /opt/project phpdoc/phpcs-ga:latest phpcbf
 
-.PHONY: phpstan
+.PHONY: static-code-analysis
-phpstan:
+static-code-analysis: vendor ## Runs a static code analysis with phpstan/phpstan and vimeo/psalm
-	docker run -it --rm -v${PWD}:/opt/project -w /opt/project phpdoc/phpstan-ga:latest analyse src --no-progress --configuration phpstan.neon
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project php:7.4 vendor/bin/phpstan --configuration=phpstan.neon
-
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project php:7.4 vendor/bin/psalm
-.PHONY: psalm
-psalm:
-	docker run -it --rm -v${PWD}:/opt/project -w /opt/project php:7.3 vendor/bin/psalm.phar
 
 .PHONY: test
-test:
+test: test-unit ## Runs all test suites with phpunit/phpunit
-	docker run -it --rm -v${CURDIR}:/github/workspace phpdoc/phpunit-ga
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project php:7.4 vendor/bin/phpunit
-	docker run -it --rm -v${CURDIR}:/data -w /data php:7.2 -f ./tests/coverage-checker.php 90
+
+.PHONY: test-unit
+test-unit: ## Runs unit tests with phpunit/phpunit
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project php:7.4 vendor/bin/phpunit --testsuite=unit
+
+.PHONY: dependency-analysis
+dependency-analysis: vendor ## Runs a dependency analysis with maglnet/composer-require-checker
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project php:7.4 .phive/composer-require-checker check --config-file=/opt/project/composer-require-checker.json
+
+vendor: composer.json composer.lock
+	composer validate --no-check-publish
+	composer install --no-interaction --no-progress
+
+.PHONY: benchmark
+benchmark:
+	docker run -it --rm -v${CURDIR}:/opt/project -w /opt/project php:7.4-cli tools/phpbench run
+
+.PHONY: rector
+rector: ## Refactor code using rector
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project php:7.4 vendor/bin/rector process
 
 .PHONY: pre-commit-test
-pre-commit-test: test phpcs phpstan psalm
+pre-commit-test: fix-code-style test code-style static-code-analysis
-

composer.json

@@ -22,7 +22,12 @@
     },
     "require-dev": {
         "mockery/mockery": "~1.3.5",
-        "psalm/phar": "^4.8"
+        "phpunit/phpunit": "^9.5",
+        "phpstan/phpstan": "^1.8",
+        "phpstan/phpstan-mockery": "^1.1",
+        "phpstan/extension-installer": "^1.1",
+        "phpstan/phpstan-webmozart-assert": "^1.2",
+        "vimeo/psalm": "^4.26"
     },
     "autoload": {
         "psr-4": {
@@ -34,6 +39,14 @@
             "phpDocumentor\\Reflection\\": ["tests/unit", "tests/integration"]
         }
     },
+    "config": {
+        "platform": {
+            "php":"7.4.0"
+        },
+        "allow-plugins": {
+            "phpstan/extension-installer": true
+        }
+    },
     "extra": {
         "branch-alias": {
             "dev-master": "5.x-dev"

phpstan.neon

@@ -1,8 +1,8 @@
-includes:
-    - /composer/vendor/phpstan/phpstan-mockery/extension.neon
-    - /composer/vendor/phpstan/phpstan-webmozart-assert/extension.neon
-
 parameters:
     level: max
     ignoreErrors:
-        - '#Call to static method Webmozart\\Assert\\Assert::implementsInterface\(\) with class-string#'
+        - '#Method phpDocumentor\\Reflection\\DocBlock\\StandardTagFactory::createTag\(\) should return phpDocumentor\\Reflection\\DocBlock\\Tag but returns mixed#'
+        - "#Strict comparison using !== between array{'name', 'type'} and array{'name', 'type'} will always evaluate to false#"
+        - '#Call to static method Webmozart\\Assert\\Assert::implementsInterface\(\) with class-string#'
+    paths:
+        - src