Merge remote-tracking branch 'upstream/2.x' into amacrobert-meq--952-integration-doc-update

* upstream/2.x:
  Correctly link to github actions docs and fix backlinks
  Improved bc check
  bug KnpLabs#979 Deployments: use proper media-type for in_progress/queued, inactive state (staabm)

Author: acrobat

.github/workflows/backwards-compatibility.yml

@@ -0,0 +1,18 @@
+name: "BC check"
+
+on:
+    pull_request:
+
+jobs:
+    roave_bc_check:
+        name: "Roave BC check"
+        runs-on: ubuntu-latest
+        steps:
+            -   uses: actions/checkout@v2
+                with:
+                    fetch-depth: 0
+
+            -   name: Roave BC Check
+                uses: docker://nyholm/roave-bc-check-ga
+                with:
+                    args: --from=${{ github.event.pull_request.base.sha }}

.github/workflows/ci.yml

@@ -28,15 +28,6 @@ jobs:
             - name: Run phpunit
               run: vendor/bin/phpunit --verbose
 
-    roave_bc_check:
-        name: Roave BC Check
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v2
-
-            - name: Roave BC Check
-              uses: docker://nyholm/roave-bc-check-ga
-
     phpstan:
         name: PHPStan
         runs-on: ubuntu-latest

doc/README.md

@@ -48,6 +48,13 @@ v3 APIs:
   * [Reviews](pull_request/reviews.md)
 * [Rate Limits](rate_limits.md)
 * [Repositories](repos.md)
+  * Actions
+    * [Artifacts](repo/actions/artifacts.md)
+    * [Secrets](repo/actions/secrets.md)
+    * [Self hosted runners](repo/actions/self_hosted_runners.md)
+    * [Workflow jobs](repo/actions/workflow_jobs.md)
+    * [Workflow runs](repo/actions/workflow_runs.md)
+    * [Workflows](repo/actions/workflows.md)
   * [Check Runs](repo/check_runs.md)
   * [Check Suites](repo/check_suites.md)
   * [Contents](repo/contents.md)

doc/repo/actions/artifacts.md

@@ -1,5 +1,5 @@
-## Repo / Artifacts API
-[Back to the "Repos API"](../repos.md) | [Back to the navigation](../README.md)
+## Repo / Actions / Artifacts API
+[Back to the "Repos API"](../../repos.md) | [Back to the navigation](../../README.md)
 
 ### List artifacts for a repository
 

doc/repo/actions/secrets.md

@@ -1,5 +1,5 @@
-## Repo / Secrets API
-[Back to the "Repos API"](../repos.md) | [Back to the navigation](../README.md)
+## Repo / Actions / Secrets API
+[Back to the "Repos API"](../../repos.md) | [Back to the navigation](../../README.md)
 
 ### List repository secrets
 

doc/repo/actions/self_hosted_runners.md

@@ -1,5 +1,5 @@
-## Repo / Self Hosted Runners API
-[Back to the "Repos API"](../repos.md) | [Back to the navigation](../README.md)
+## Repo / Actions / Self Hosted Runners API
+[Back to the "Repos API"](../../repos.md) | [Back to the navigation](../../README.md)
 
 # List self-hosted runners for a repository
 

doc/repo/actions/workflow_jobs.md

@@ -1,5 +1,5 @@
-## Repo / Workflow Jobs API
-[Back to the "Repos API"](../repos.md) | [Back to the navigation](../README.md)
+## Repo / Actions / Workflow Jobs API
+[Back to the "Repos API"](../../repos.md) | [Back to the navigation](../../README.md)
 
 ### List jobs for a workflow run
 

doc/repo/actions/workflow_runs.md

@@ -1,5 +1,5 @@
-## Repo / Workflow Runs API
-[Back to the "Repos API"](../repos.md) | [Back to the navigation](../README.md)
+## Repo / Actions / Workflow Runs API
+[Back to the "Repos API"](../../repos.md) | [Back to the navigation](../../README.md)
 
 ### List workflow runs for a repository
 

doc/repo/actions/workflows.md

@@ -1,5 +1,5 @@
-## Repo / Workflows API
-[Back to the "Repos API"](../repos.md) | [Back to the navigation](../README.md)
+## Repo / Actions / Workflows API
+[Back to the "Repos API"](../../repos.md) | [Back to the navigation](../../README.md)
 
 ### List repository workflows
 

lib/Github/Api/Deployment.php

@@ -11,6 +11,8 @@
  */
 class Deployment extends AbstractApi
 {
+    use AcceptHeaderTrait;
+
     /**
      * List deployments for a particular repository.
      *
@@ -88,6 +90,15 @@ public function updateStatus($username, $repository, $id, array $params)
             throw new MissingArgumentException(['state']);
         }
 
+        // adjust media-type per github docs
+        // https://docs.github.com/en/rest/reference/repos#create-a-deployment-status
+        if ($params['state'] === 'inactive') {
+            $this->acceptHeaderValue = 'application/vnd.github.ant-man-preview+json';
+        }
+        if ($params['state'] === 'in_progress' || $params['state'] === 'queued') {
+            $this->acceptHeaderValue = 'application/vnd.github.flash-preview+json';
+        }
+
         return $this->post('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/deployments/'.$id.'/statuses', $params);
     }