diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 9977d13..e5b5720 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -49,7 +49,7 @@ jobs: - name: Upload to Codecov 📊 uses: codecov/codecov-action@v3 with: - token: ${{ secrets.CODE_COV_TOKEN }} + token: ${{ secrets.CODECOV_TOKEN }} files: ./coverage.xml verbose: true diff --git a/README.md b/README.md index 633de6e..1e2b9f2 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Inpi RNE PHP is a PHP library to easily interact with RNE INPI API. It allow use This version is based on the INPI Documentation located in data folder of this repository ## Requirements -PHP 8.1.0 and later. +PHP 8.2.0 and later. ## Installation Use [Composer](https://getcomposer.org/) to install this package : @@ -41,5 +41,12 @@ $data = $client->searchBySiren('889924320'); To execute tests of the package : vendor/bin/phpunit +## Code coverage +To maintain good code quality, we encourage contributors to have the best code coverage +You have to generate the coverage report with a tool like xdebug when it's installed you can launch this command : +```XDEBUG_MODE=coverage ./vendor/bin/phpunit --configuration phpunit.xml --coverage-clover test-reports/cov.xml``` + +If you use VSCode you can show it with this extension : [Coverage Gutters](https://github.com/ryanluker/vscode-coverage-gutters/) + ## Authors Kanta Inc