Merge pull request #10 from reactphp-parallel/sync-makefile-and-ci

Sync Makefile and CI

Author: WyriHaximus

.github/workflows/ci.yml

@@ -3,6 +3,18 @@ on:
   push:
   pull_request:
 jobs:
+  generate-checks-strategy:
+    name: Generate Checks
+    runs-on: ubuntu-latest
+    outputs:
+      check: ${{ steps.generate-checks-strategy.outputs.check }}
+    steps:
+      - uses: actions/checkout@v1
+      - id: generate-checks-strategy
+        name: Generate check
+        run: |
+          printf "Checks found: %s\r\n" $(make task-list-ci)
+          printf "::set-output name=check::%s" $(make task-list-ci)
   lint:
    runs-on: ubuntu-latest
    steps:
@@ -17,7 +29,7 @@ jobs:
     needs: lint
     runs-on: ubuntu-latest
     container:
-      image: wyrihaximusnet/php:${{ matrix.php }}-zts-alpine3.11-dev-root
+      image: wyrihaximusnet/php:${{ matrix.php }}-zts-alpine3.12-dev-root
     steps:
       - uses: actions/checkout@v1
       - name: Cache composer packages
@@ -40,11 +52,13 @@ jobs:
       matrix:
         php: [7.4]
         composer: [lowest, current, highest]
-        qa: [lint, cs, stan, psalm, unit-ci, infection, composer-require-checker, composer-unused, backward-compatibility-check]
-    needs: composer-install
+        check: ${{ fromJson(needs.generate-checks-strategy.outputs.check) }}
+    needs:
+      - composer-install
+      - generate-checks-strategy
     runs-on: ubuntu-latest
     container:
-      image: wyrihaximusnet/php:${{ matrix.php }}-zts-alpine3.11-dev-root
+      image: wyrihaximusnet/php:${{ matrix.php }}-zts-alpine3.12-dev-root
     steps:
       - uses: actions/checkout@v1
       - name: Cache composer packages
@@ -62,6 +76,6 @@ jobs:
         run: (test -f vendor && true ) || composer update --ansi --no-progress --no-interaction --prefer-dist -o
         if: matrix.composer == 'highest'
       - name: Fetch Tags
-        run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
-        if: matrix.qa == 'backward-compatibility-check'
-      - run: make ${{ matrix.qa }}
+        run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* || true
+        if: matrix.check == 'backward-compatibility-check'
+      - run: make ${{ matrix.check }}

Makefile

@@ -22,34 +22,45 @@ else
 		"wyrihaximusnet/php:7.4-zts-alpine3.12-dev"
 endif
 
-all: lint cs-fix cs stan composer-require-checker composer-unused unit infection
+all: syntax-php cs-fix cs stan psalm unit infection composer-require-checker composer-unused backward-compatibility-check
 
-lint:
+syntax-php: ## Lint PHP syntax
 	$(DOCKER_RUN) vendor/bin/parallel-lint --exclude vendor .
 
-cs:
+cs: ## Check the code for code style issues
 	$(DOCKER_RUN) vendor/bin/phpcs --parallel=$(shell nproc)
 
-cs-fix:
+cs-fix: ## Fix any automatically fixable code style issues
 	$(DOCKER_RUN) vendor/bin/phpcbf --parallel=$(shell nproc)
 
-stan:
+stan: ## Run static analysis (PHPStan)
 	$(DOCKER_RUN) vendor/bin/phpstan analyse src tests --level max --ansi -c phpstan.neon
 
-psalm:
+psalm: ## Run static analysis (Psalm)
 	$(DOCKER_RUN) vendor/bin/psalm --threads=$(shell nproc) --shepherd --stats
 
-unit:
+unit: ## Run tests
 	$(DOCKER_RUN) vendor/bin/phpunit --colors=always -c phpunit.xml.dist --coverage-text --coverage-html covHtml --coverage-clover ./build/logs/clover.xml
 
 unit-ci: unit
-	if [ -f ./build/logs/clover.xml ]; then sleep 3; fi
+	if [ -f ./build/logs/clover.xml ]; then wget https://scrutinizer-ci.com/ocular.phar && sleep 3 && php ocular.phar code-coverage:upload --format=php-clover ./build/logs/clover.xml; fi
 
-infection:
+infection: ## Run mutation testing
 	$(DOCKER_RUN) vendor/bin/infection --ansi --min-msi=100 --min-covered-msi=100 --threads=$(shell nproc)
 
-composer-require-checker:
+composer-require-checker: ## Ensure we require every package used in this package directly
 	$(DOCKER_RUN) vendor/bin/composer-require-checker --ignore-parse-errors --ansi -vvv --config-file=composer-require-checker.json
 
-composer-unused:
+composer-unused: ## Ensure we don't require any package we don't use in this package directly
 	$(DOCKER_RUN) composer unused --ansi
+
+backward-compatibility-check: ## Check code for backwards incompatible changes
+	$(DOCKER_RUN) vendor/bin/roave-backward-compatibility-check || true
+
+task-list-ci:
+	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "%s\n", $$1}' | jq --raw-input --slurp -c 'split("\n")| .[0:-1]'
+
+help:
+	@printf "\033[33mUsage:\033[0m\n  make [target]\n\n\033[33mTargets:\033[0m\n"
+	@printf "  \033[32m%-32s\033[0m %s\n"  "all" "Runs everything"
+	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[32m%-32s\033[0m %s\n", $$1, $$2}'