Merge branch 'main' into releases/v2

chrnorm · May 22, 2022 · b11a06a · b11a06a
2 parents 58d8237 + 880668c
commit b11a06a
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,22 @@
 
 A GitHub action to create [Deployments](https://developer.github.com/v3/repos/deployments/) as part of your GitHub CI workflows.
 
+## Required Permissions
+
+\*\*Important: you must grant your GitHub Actions workflow deployment permissions as shown below. Otherwise, this Action will not work.
+
+```yaml
+jobs:
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-latest
+
+    permissions:
+      deployments: write
+
+    # ...
+```
+
 ## Example usage
 
 ```yaml
@@ -15,6 +31,9 @@ jobs:
 
     runs-on: ubuntu-latest
 
+    permissions:
+      deployments: write
+
     steps:
       - uses: actions/checkout@v1
 
@@ -53,10 +72,11 @@ jobs:
 
 ## Action outputs
 
-| name             | description                                            |
-| ---------------- | ------------------------------------------------------ |
-| `deployment_id`  | The ID of the deployment as returned by the GitHub API |
-| `deployment_url` | The URL of the created deployment                      |
+| name              | description                                                            |
+| ----------------- | ---------------------------------------------------------------------- |
+| `deployment_id`   | The ID of the deployment as returned by the GitHub API                 |
+| `deployment_url`  | The URL of the created deployment                                      |
+| `environment_url` | The environment URL of the deployment (the same as the input variable) |
 
 ## Notes
 
@@ -99,18 +119,18 @@ jobs:
         uses: chrnorm/deployment-status@v2
         with:
           token: '${{ github.token }}'
-          environment-url: http://my-app-url.com
-          state: 'success'
+          environment-url: ${{ steps.deployment.outputs.environment_url }}
           deployment-id: ${{ steps.deployment.outputs.deployment_id }}
+          state: 'success'
 
       - name: Update deployment status (failure)
         if: failure()
         uses: chrnorm/deployment-status@v2
         with:
           token: '${{ github.token }}'
-          environment-url: http://my-app-url.com
-          state: 'failure'
+          environment-url: ${{ steps.deployment.outputs.environment_url }}
           deployment-id: ${{ steps.deployment.outputs.deployment_id }}
+          state: 'failure'
 ```
 
 ## Breaking changes

diff --git a/action.yml b/action.yml
@@ -70,7 +70,8 @@ outputs:
     description: 'The ID of the created deployment'
   deployment_url:
     description: 'The URL of the created deployment'
-
+  environment_url:
+    description: 'The environment URL of the deployment'
 runs:
   using: 'node16'
   main: 'dist/index.js'
diff --git a/dist/index.js b/dist/index.js
@@ -104,6 +104,7 @@ function run() {
             yield octokit.rest.repos.createDeploymentStatus(Object.assign(Object.assign({}, context.repo), { deployment_id: deployment.data.id, description, state: initialStatus, log_url: logUrl, environment_url: environmentUrl, auto_inactive: autoInactive }));
             core.setOutput('deployment_id', deployment.data.id.toString());
             core.setOutput('deployment_url', deployment.data.url);
+            core.setOutput('environment_url', environmentUrl);
         }
         catch (error) {
             core.error(error);

diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/lib/main.js b/lib/main.js
@@ -97,6 +97,7 @@ function run() {
             yield octokit.rest.repos.createDeploymentStatus(Object.assign(Object.assign({}, context.repo), { deployment_id: deployment.data.id, description, state: initialStatus, log_url: logUrl, environment_url: environmentUrl, auto_inactive: autoInactive }));
             core.setOutput('deployment_id', deployment.data.id.toString());
             core.setOutput('deployment_url', deployment.data.url);
+            core.setOutput('environment_url', environmentUrl);
         }
         catch (error) {
             core.error(error);

diff --git a/src/main.ts b/src/main.ts
@@ -106,6 +106,7 @@ async function run(): Promise<void> {
 
     core.setOutput('deployment_id', deployment.data.id.toString())
     core.setOutput('deployment_url', deployment.data.url)
+    core.setOutput('environment_url', environmentUrl)
   } catch (error: any) {
     core.error(error)
     core.setFailed(`Error creating GitHub deployment: ${error.message}`)