Merge pull request #25 from OpenRailAssociation/create-gh-deployments

Add option to create GitHub deployments

Author: mxmehl

.github/workflows/selftest.yml

@@ -71,3 +71,4 @@ jobs:
           linkchecker_exclude: "example.com,example.org"
           linkchecker_include_fragments: true
           linkchecker_verbose: true
+          gh_deployment: "preview"

README.md

@@ -110,6 +110,7 @@ jobs:
 | `linkchecker_verbose` | <p>Turn on verbose linkchecker logging in action logs (true/false)</p> | `false` | `false` |
 | `sticky_comment_enabled` | <p>Whether to enable sticky comments for the pull request. Defaults to true.</p> | `false` | `true` |
 | `step_summary_enabled` | <p>Whether to enable step summaries in the GitHub Actions UI. Defaults to true.</p> | `false` | `true` |
+| `gh_deployment` | <p>Name of the optional GitHub deployment to create. Requires the deployments permission. Defaults to empty, in which case no deployment is created.</p> | `false` | `""` |
 <!-- action-docs-inputs source="action.yml" -->
 
 <!-- action-docs-outputs source="action.yml" -->

action.yml

@@ -134,6 +134,11 @@ inputs:
     required: false
     default: "true"
 
+  gh_deployment:
+    description: "Name of the optional GitHub deployment to create. Requires the deployments permission. Defaults to empty, in which case no deployment is created."
+    required: false
+    default: ""
+
 outputs:
   url:
     description: "The URL of the deployed production or preview website"
@@ -279,6 +284,16 @@ runs:
           :---:
           | <p><br />:x: Preview has been removed.<br /><br /></p>
 
+    - name: "Create GitHub deployment"
+      if: inputs.gh_deployment != '' && env.IS_PREVIEW == 'true'
+      uses: chrnorm/deployment-action@51e93982518dc06e500fe65559032a439663aaac # v2.0.7
+      with:
+        token: "${{ github.token }}"
+        environment: "${{ inputs.gh_deployment }}"
+        environment-url: "${{ env.URL }}"
+        transient-environment: true
+        initial-status: "success"
+
     # ----------------------------------------------------------------------------------------------
     # LINK CHECKER
     # ----------------------------------------------------------------------------------------------