Merge branch 'main' into releases/v2

Author: chrnorm

README.md

@@ -2,9 +2,31 @@
 
 A GitHub action to create [Deployments](https://developer.github.com/v3/repos/deployments/) as part of your GitHub CI workflows.
 
-## Breaking changes
+## Example usage
 
-`v2` of this action removes the `target_url` input and replaces it with the `environment_url` and `log_url` inputs to match GitHub's API. `v2` also standardises on using `kebab-case` rather than `snake_case` for inputs to match GitHub's built-in actions.
+```yaml
+name: Deploy
+
+on: [push]
+
+jobs:
+  deploy:
+    name: Deploy my app
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: chrnorm/deployment-action@v2
+        name: Create GitHub deployment
+        id: deployment
+        with:
+          token: '${{ github.token }}'
+          environment-url: http://my-app-url.com
+          environment: production
+        # more steps below where you run your deployment scripts inside the same action
+```
 
 ## Action inputs
 
@@ -33,34 +55,8 @@ A GitHub action to create [Deployments](https://developer.github.com/v3/repos/de
 
 | name             | description                                            |
 | ---------------- | ------------------------------------------------------ |
-| `deployment-id`  | The ID of the deployment as returned by the GitHub API |
-| `deployment-url` | The URL of the created deployment                      |
-
-## Example usage
-
-```yaml
-name: Deploy
-
-on: [push]
-
-jobs:
-  deploy:
-    name: Deploy my app
-
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v1
-
-      - uses: chrnorm/deployment-action@releases/v1
-        name: Create GitHub deployment
-        id: deployment
-        with:
-          token: '${{ github.token }}'
-          environment-url: http://my-app-url.com
-          environment: production
-        # more steps below where you run your deployment scripts inside the same action
-```
+| `deployment_id`  | The ID of the deployment as returned by the GitHub API |
+| `deployment_url` | The URL of the created deployment                      |
 
 ## Notes
 
@@ -105,7 +101,7 @@ jobs:
           token: '${{ github.token }}'
           environment-url: http://my-app-url.com
           state: 'success'
-          deployment-id: ${{ steps.deployment.outputs.deployment-id }}
+          deployment-id: ${{ steps.deployment.outputs.deployment_id }}
 
       - name: Update deployment status (failure)
         if: failure()
@@ -114,5 +110,9 @@ jobs:
           token: '${{ github.token }}'
           environment-url: http://my-app-url.com
           state: 'failure'
-          deployment-id: ${{ steps.deployment.outputs.deployment-id }}
+          deployment-id: ${{ steps.deployment.outputs.deployment_id }}
 ```
+
+## Breaking changes
+
+`v2` of this action removes the `target_url` input and replaces it with the `environment_url` and `log_url` inputs to match GitHub's API. `v2` also standardises on using `kebab-case` rather than `snake_case` for inputs to match GitHub's built-in actions.

action.yml

@@ -66,9 +66,9 @@ inputs:
     description: 'Changes the API base URL for a GitHub Enterprise server.'
     required: false
 outputs:
-  deployment-id:
+  deployment_id:
     description: 'The ID of the created deployment'
-  deployment-url:
+  deployment_url:
     description: 'The URL of the created deployment'
 
 runs:

dist/index.js

@@ -102,8 +102,8 @@ function run() {
                 throw new Error(deployment.data.message);
             }
             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('deployment_id', deployment.data.id.toString());
+            core.setOutput('deployment_url', deployment.data.url);
         }
         catch (error) {
             core.error(error);

dist/index.js.map

@@ -95,8 +95,8 @@ function run() {
                 throw new Error(deployment.data.message);
             }
             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('deployment_id', deployment.data.id.toString());
+            core.setOutput('deployment_url', deployment.data.url);
         }
         catch (error) {
             core.error(error);

lib/main.js

@@ -104,8 +104,8 @@ async function run(): Promise<void> {
       auto_inactive: autoInactive
     })
 
-    core.setOutput('deployment-id', deployment.data.id.toString())
-    core.setOutput('deployment-url', deployment.data.url)
+    core.setOutput('deployment_id', deployment.data.id.toString())
+    core.setOutput('deployment_url', deployment.data.url)
   } catch (error: any) {
     core.error(error)
     core.setFailed(`Error creating GitHub deployment: ${error.message}`)