Update pipelines (#51)

yiisoft · Nov 18, 2020 · 885938e · 885938e
1 parent 78c0161
commit 885938e
Show file tree

Hide file tree

Showing 6 changed files with 83 additions and 31 deletions.
diff --git a/.github/workflows/bc.yml_ b/.github/workflows/bc.yml_
@@ -0,0 +1,15 @@
+on:
+    - pull_request
+    - push
+
+name: backwards compatibility
+jobs:
+    roave_bc_check:
+        name: Roave BC Check
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@master
+            - name: fetch tags
+              run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
+            - name: Roave BC Check
+              uses: docker://nyholm/roave-bc-check-ga
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -25,13 +25,12 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v2.3.4
 
       - name: Install PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
-          extensions: ${{ env.extensions }}
           ini-values: date.timezone='UTC'
           coverage: pcov
           tools: composer:v2
@@ -42,7 +41,7 @@ jobs:
 
       - name: Determine composer cache directory on Windows
         if: matrix.os == 'windows-latest'
-        run: ECHO "COMPOSER_CACHE_DIR=~\AppData\Local\Composer" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+        run: echo "COMPOSER_CACHE_DIR=~\AppData\Local\Composer" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
 
       - name: Cache dependencies installed with composer
         uses: actions/cache@v2
@@ -52,6 +51,9 @@ jobs:
           restore-keys: |
             php${{ matrix.php }}-composer-
 
+      - name: Update composer
+        run: composer self-update
+
       - name: Install dependencies with composer php 7.4
         if: matrix.php == '7.4'
         run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
@@ -60,16 +62,5 @@ jobs:
         if: matrix.php == '8.0'
         run: composer update --ignore-platform-reqs --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
 
-      - name: Run tests with phpunit and coverage on Linux php 7.4
-        if: matrix.os == 'ubuntu-latest' && matrix.php == '7.4'
-        run: vendor/bin/phpunit --coverage-clover=coverage.clover --colors=always
-
-      - name: Run tests with phpunit without coverage
-        if: matrix.os != 'ubuntu-latest' || matrix.php != '7.4'
+      - name: Run tests with phpunit
         run: vendor/bin/phpunit --colors=always
-
-      - name: Upload code coverage scrutinizer on Linux php 7.4
-        if: matrix.os == 'ubuntu-latest' && matrix.php == '7.4'
-        run: |
-          wget https://scrutinizer-ci.com/ocular.phar
-          php ocular.phar code-coverage:upload --format=php-clover coverage.clover
diff --git a/.github/workflows/mutation.yml b/.github/workflows/mutation.yml
@@ -22,7 +22,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v2.3.4
 
       - name: Install PHP
         uses: shivammathur/setup-php@v2
@@ -43,12 +43,15 @@ jobs:
           restore-keys: |
             php${{ matrix.php }}-composer-
 
+      - name: Update composer
+        run: composer self-update
+
       - name: Install dependencies with composer
         run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
 
       - name: Run infection
         run: |
           git fetch --depth=1 origin $GITHUB_BASE_REF
-          vendor/bin/infection -j2 --git-diff-filter=A --git-diff-base=origin/$GITHUB_BASE_REF --logger-github --ignore-msi-with-no-mutations --only-covered
+          vendor/bin/roave-infection-static-analysis-plugin -j2 --git-diff-filter=A --git-diff-base=origin/$GITHUB_BASE_REF --logger-github --ignore-msi-with-no-mutations --only-covered
         env:
           STRYKER_DASHBOARD_API_KEY: ${{ secrets.STRYKER_DASHBOARD_API_KEY }}
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -8,9 +8,6 @@ jobs:
   mutation:
     name: PHP ${{ matrix.php }}-${{ matrix.os }}
 
-    env:
-      extensions: ast
-
     runs-on: ${{ matrix.os }}
 
     strategy:
@@ -23,18 +20,17 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v2.3.4
 
-      - name: Install PHP"
+      - name: Install PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: "${{ matrix.php }}"
-          extensions: ${{ env.extensions }}
           tools: composer:v2, cs2pr
           coverage: none
 
       - name: Determine composer cache directory
-        run: echo "::set-env name=COMPOSER_CACHE_DIR::$(composer config cache-dir)"
+        run: echo "COMPOSER_CACHE_DIR=$(composer config cache-dir)" >> $GITHUB_ENV
 
       - name: Cache dependencies installed with composer
         uses: actions/cache@v2
@@ -44,8 +40,11 @@ jobs:
           restore-keys: |
             php${{ matrix.php }}-composer-
 
+      - name: Update composer
+        run: composer self-update
+
       - name: Install dependencies with composer
-        run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader
+        run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
 
-      - name: Static analysis with psalm
+      - name: Static analysis
         run: vendor/bin/psalm --shepherd --stats --output-format=checkstyle | cs2pr --graceful-warnings --colorize
diff --git a/README.md b/README.md
@@ -15,6 +15,7 @@ The package provides FastRoute adapter for [Yii Router](https://github.com/yiiso
 [![Code Coverage](https://scrutinizer-ci.com/g/yiisoft/router-fastroute/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/yiisoft/router-fastroute/?branch=master)
 [![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fyiisoft%2Frouter-fastroute%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/router-fastroute/master)
 [![static analysis](https://github.com/yiisoft/router-fastroute/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/router-fastroute/actions?query=workflow%3A%22static+analysis%22)
+[![type-coverage](https://shepherd.dev/github/yiisoft/router-fastroute/coverage.svg)](https://shepherd.dev/github/yiisoft/router-fastroute)
 
 ## General usage
 
@@ -72,3 +73,46 @@ return [
     RouterInterface::class => new RouteFactory(),
 ];
 ```
+
+### Unit testing
+
+The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
+
+```shell
+./vendor/bin/phpunit
+```
+
+### Mutation testing
+
+The package tests are checked with [Infection](https://infection.github.io/) mutation framework. To run it:
+
+```shell
+./vendor/bin/infection
+```
+
+### Static analysis
+
+The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
+
+```shell
+./vendor/bin/psalm
+```
+
+### Support the project
+
+[![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective&logoColor=7eadf1&labelColor=555555)](https://opencollective.com/yiisoft)
+
+### Follow updates
+
+[![Official website](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](https://www.yiiframework.com/)
+[![Twitter](https://img.shields.io/badge/twitter-follow-1DA1F2?logo=twitter&logoColor=1DA1F2&labelColor=555555?style=flat)](https://twitter.com/yiiframework)
+[![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en)
+[![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)
+[![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack)
+
+## License
+
+The Yii Router FastRoute adapter is free software. It is released under the terms of the BSD License.
+Please see [`LICENSE`](./LICENSE.md) for more information.
+
+Maintained by [Yii Software](https://www.yiiframework.com/).
diff --git a/composer.json b/composer.json
@@ -19,15 +19,15 @@
     "require": {
         "php": "^7.4|^8.0",
         "nikic/fast-route": "^1.3",
-        "psr/simple-cache": "~1.0.0",
+        "psr/simple-cache": "^1.0.1",
         "yiisoft/router": "^3.0@dev"
     },
     "require-dev": {
         "nyholm/psr7": "^1.3",
-        "phpunit/phpunit": "^9.3",
-        "psr/container": "1.0.0",
-        "infection/infection": "^0.20.1",
-        "vimeo/psalm": "^4.0"
+        "phpunit/phpunit": "^9.4",
+        "psr/container": "1.0",
+        "roave/infection-static-analysis-plugin": "^1.4",
+        "vimeo/psalm": "^4.1"
     },
     "autoload": {
         "psr-4": {