Merge branch '2.x'

* 2.x:
  Update apps.md
  Update branch alias after 2.17 release
  Update changelog for 2.17.0 release
  Improve github actions setup
  Improve checks api implementation
  Fix: Missing auth method in list of omitted passwords.
  Update branch-alias after 2.16.0 release
  Update changelog for 2.16.0 release

Author: acrobat

.github/workflows/ci.yml

@@ -5,10 +5,11 @@ on:
 
 jobs:
     test:
-        name: Test on ${{ matrix.php-versions }} PHP
+        name: Test on PHP ${{ matrix.php-versions }}
         runs-on: ubuntu-latest
 
         strategy:
+            fail-fast: false
             matrix:
                 php-versions: ['7.1', '7.2', '7.3', '7.4']
 
@@ -19,13 +20,13 @@ jobs:
               uses: shivammathur/setup-php@v2
               with:
                   php-version: ${{ matrix.php-versions }}
-                  coverage: xdebug
+                  coverage: none
 
             - name: Install Composer Dependencies
               uses: ramsey/composer-install@v1
 
             - name: Run phpunit
-              run: vendor/bin/phpunit --verbose --coverage-text
+              run: vendor/bin/phpunit --verbose
 
     roave_bc_check:
         name: Roave BC Check
@@ -39,6 +40,7 @@ jobs:
 #              uses: docker://nyholm/roave-bc-check-ga
 
     phpstan:
+        name: PHPStan
         runs-on: ubuntu-latest
 
         steps:
@@ -47,6 +49,7 @@ jobs:
             - uses: shivammathur/setup-php@v2
               with:
                   php-version: 7.1
+                  coverage: none
 
             - name: Install Composer Dependencies
               uses: ramsey/composer-install@v1

CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## 2.17.0
+
+### Added
+
+- Improve checks api implementation ([acrobat](https://github.com/acrobat)) [#932](https://github.com/KnpLabs/php-github-api/issues/932)
+
+### Changed
+- Missing auth method in list of omitted passwords. ([tobyS](https://github.com/tobyS)) [#933](https://github.com/KnpLabs/php-github-api/issues/933)
+- Improve github actions setup ([acrobat](https://github.com/acrobat)) [#935](https://github.com/KnpLabs/php-github-api/issues/935)
+
+## 2.16.0
+
+### Added
+- Add support for SSO errors coming from the API ([eiriksm](https://github.com/eiriksm)) [#913](https://github.com/KnpLabs/php-github-api/issues/913)
+- Add OutsideCollaborators api ([Matth--](https://github.com/Matth--)) [#925](https://github.com/KnpLabs/php-github-api/issues/925)
+- Add support for creating a repo dispatch event ([Nyholm](https://github.com/Nyholm)) [#931](https://github.com/KnpLabs/php-github-api/issues/931)
+
+### Changed
+- Fix: Wrong PHPDoc description ([OskarStark](https://github.com/OskarStark)) [#922](https://github.com/KnpLabs/php-github-api/issues/922)
+- Adding GitHub authentication to GraphQL documentation ([legionth](https://github.com/legionth)) [#927](https://github.com/KnpLabs/php-github-api/issues/927)
+
+### Fixed
+- Use RFC3986 for building URI query strings ([GrahamCampbell](https://github.com/GrahamCampbell)) [#908](https://github.com/KnpLabs/php-github-api/issues/908)
+- Fix call to test a webhook method ([morrislaptop](https://github.com/morrislaptop)) [#915](https://github.com/KnpLabs/php-github-api/issues/915)
+
 ## 2.15.0
 
 ### Added

composer.json

@@ -47,7 +47,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-2.x": "2.15.x-dev",
+            "dev-2.x": "2.17.x-dev",
             "dev-master": "3.0.x-dev"
         }
     }

doc/README.md

@@ -48,7 +48,8 @@ v3 APIs:
   * [Reviews](pull_request/reviews.md)
 * [Rate Limits](rate_limits.md)
 * [Repositories](repos.md)
-  * [Checks](repo/checks.md)
+  * [Check Runs](repo/check_runs.md)
+  * [Check Suites](repo/check_suites.md)
   * [Contents](repo/contents.md)
   * [Deployments](repo/deployments.md)
   * [Labels](repo/labels.md)

doc/apps.md

@@ -36,7 +36,7 @@ $repositories = $client->api('apps')->listRepositories(456);
 
 ### List repositories for a given installation and user
 
-```
+```php
 $repositories = $client->api('current_user')->repositoriesByInstallation(456);
 ```
 

doc/repo/check_runs.md

@@ -0,0 +1,67 @@
+## Repo / Checks runs API
+[Back to the "Repos API"](../repos.md) | [Back to the navigation](../README.md)
+
+### Create a check run
+
+[Visit GitHub for a full of list of parameters and their descriptions.](https://docs.github.com/en/free-pro-team@latest/rest/reference/checks#create-a-check-run)
+
+```php
+$params = [
+  'name' => 'my check', # required
+  'head_sha' => $commitSha, # required
+  'status' => 'queued',
+  'output' => [/*...*/]
+];
+$check = $client->api('repo')->checkRuns()->create('KnpLabs', 'php-github-api', $params);
+```
+
+### Get a check run
+
+https://docs.github.com/en/free-pro-team@latest/rest/reference/checks#get-a-check-run
+
+```php
+$check = $client->api('repo')->checkRuns()->show('KnpLabs', 'php-github-api', $checkRunId);
+```
+
+### Update an existing check run
+
+https://docs.github.com/en/free-pro-team@latest/rest/reference/checks#update-a-check-run
+
+```php
+$params = [
+  'name' => 'my check',
+  'status' => 'in_progress',
+  'output' => [/*...*/]
+];
+$check = $client->api('repo')->checkRuns()->update('KnpLabs', 'php-github-api', $checkRunId, $params);
+```
+
+### List check run annotations
+
+https://docs.github.com/en/free-pro-team@latest/rest/reference/checks#list-check-run-annotations
+
+```php
+$annotations = $client->api('repo')->checkRuns()->annotations('KnpLabs', 'php-github-api', $checkRunId);
+```
+
+### List check runs for a check suite
+
+https://docs.github.com/en/free-pro-team@latest/rest/reference/checks#list-check-runs-in-a-check-suite
+
+```php
+$params = [/*...*/];
+$checks = $client->api('repo')->checkRuns()->allForCheckSuite('KnpLabs', 'php-github-api', $checkSuiteId, $params);
+```
+
+### List check runs for a Git reference
+
+https://docs.github.com/en/free-pro-team@latest/rest/reference/checks#list-check-runs-for-a-git-reference
+
+```php
+$params = [/*...*/];
+$checks = $client->api('repo')->checkRuns()->allForReference('KnpLabs', 'php-github-api', $reference, $params);
+```
+
+
+
+

doc/repo/check_suites.md

@@ -0,0 +1,48 @@
+## Repo / Check suites API
+[Back to the "Repos API"](../repos.md) | [Back to the navigation](../README.md)
+
+### Create a check suite
+
+https://docs.github.com/en/free-pro-team@latest/rest/reference/checks#create-a-check-suite
+
+```php
+$params = [
+  'head_sha' => $commitSha, # required
+];
+$check = $client->api('repo')->checkSuites()->create('KnpLabs', 'php-github-api', $params);
+```
+
+### Update check suite preferences
+
+https://docs.github.com/en/free-pro-team@latest/rest/reference/checks#update-repository-preferences-for-check-suites
+
+```php
+$params = [/*...*/];
+$check = $client->api('repo')->checkSuites()->updatePreferences('KnpLabs', 'php-github-api', $params);
+```
+
+### Get a check suite
+
+https://docs.github.com/en/free-pro-team@latest/rest/reference/checks#get-a-check-suite
+
+```php
+$check = $client->api('repo')->checkSuites()->getCheckSuite('KnpLabs', 'php-github-api', $checkSuiteId);
+```
+
+### Rerequest a check suite
+
+https://docs.github.com/en/free-pro-team@latest/rest/reference/checks#rerequest-a-check-suite
+
+```php
+$annotations = $client->api('repo')->checkSuites()->rerequest('KnpLabs', 'php-github-api', $checkSuiteId);
+```
+
+
+### List check suites for a Git reference
+
+https://docs.github.com/en/free-pro-team@latest/rest/reference/checks#list-check-suites-for-a-git-reference
+
+```php
+$params = [/*...*/];
+$checks = $client->api('repo')->checkSuites()->allForReference('KnpLabs', 'php-github-api', $reference, $params);
+```

doc/repo/checks.md

@@ -1,6 +1,8 @@
 ## Repo / Checks API
 [Back to the "Repos API"](../repos.md) | [Back to the navigation](../README.md)
 
+**This API class is deprecated use the [Check runs](check_runs.md) and the [Check suites](check_suites.md) api classes.**
+
 ### Create a check for a commit
 
 [Visit GitHub for a full of list of parameters and their descriptions.](https://developer.github.com/v3/checks/runs/#create-a-check-run)

doc/security.md

@@ -21,7 +21,7 @@ and guess what should contain `$password`. The `$method` can contain one of the
 * `Github\Client::AUTH_ACCESS_TOKEN` - https://developer.github.com/v3/#oauth2-token-sent-in-a-header
 * `Github\Client::AUTH_JWT` - https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app
 
-The required value of `$password` depends on the chosen `$method`. For `Github\Client::AUTH_ACCESS_TOKEN` and
+The required value of `$password` depends on the chosen `$method`. For `Github\Client::AUTH_ACCESS_TOKEN`, `Github\Client::AUTH_ACCESS_TOKEN` and
 `Github\Client::JWT` methods you should provide the API token in `$usernameOrToken` variable (`$password` is omitted in
 this particular case).
 

lib/Github/Api/Repo.php

@@ -3,6 +3,8 @@
 namespace Github\Api;
 
 use Github\Api\Repository\Checks;
+use Github\Api\Repository\Checks\CheckRuns;
+use Github\Api\Repository\Checks\CheckSuites;
 use Github\Api\Repository\Collaborators;
 use Github\Api\Repository\Comments;
 use Github\Api\Repository\Commits;
@@ -319,14 +321,33 @@ public function commits()
      * Manage checks on a repository.
      *
      * @link https://developer.github.com/v3/checks/
+     * @deprecated since 2.17 and will be removed in 3.0. Use the "checkRuns" or "checkSuites" api's instead.
      *
      * @return Checks
      */
     public function checks()
     {
+        @trigger_error(sprintf('The "%s" is deprecated since knp-labs/php-github-api 2.17 and will be removed in knp-labs/php-github-api 3.0. Use the "checkRuns" or "checkSuites" api\'s instead.', __METHOD__), E_USER_DEPRECATED);
+
         return new Checks($this->client);
     }
 
+    /**
+     * @link https://docs.github.com/en/free-pro-team@latest/rest/reference/checks#check-runs
+     */
+    public function checkRuns(): CheckRuns
+    {
+        return new CheckRuns($this->client);
+    }
+
+    /**
+     * @link https://docs.github.com/en/free-pro-team@latest/rest/reference/checks#check-suites
+     */
+    public function checkSuites(): CheckSuites
+    {
+        return new CheckSuites($this->client);
+    }
+
     /**
      * Manage the content of a repository.
      *