create-github-deployment

This action creates GitHub Deployments and Deployment Statuses through GitHub's API. When the action runs it will add a deployment and deployment status record to the repository.

This action defaults the deployment.task to workflowdeploy and is designed to work with a custom Spotify Backstage Plugin im-open/im-github-deployments. It's a dashboard that utilizes custom deployment payload data.

Inputs

Parameter	Is Required	Description
`workflow-actor`	true	The GitHub user who triggered the workflow
`token`	true	A token with `repo_deployment` permissions to create and update issues, workflows using this action should be granted `permissions` of `deployments: write`
`environment`	true	The environment the release was deployed to, i.e. `[Dev\|QA\|Stage\|Demo\|UAT\|Prod]`
`release-ref`	true	The branch, tag or SHA that was deployed
`deployment-status`	true	The status of the deployment, accepted values are `[success\|error\|failure\|inactive\|in_progress\|queued\|pending]`
`deployment-description`	false	Any description or message about the deployment
`entity`	true	The entity that is deployed, i.e. `proj-app`, `proj-infrastruction` or `proj-db`
`instance`	true	A freeform identifier to distinguish separately deployed instances of the entity in the same environment. Typical uses would be to name a slot and/or region, e.g `NA26`, `NA26-slot1`, `NA27-blue`

Outputs

Parameter	Description
`github-deployment-id`	The GitHub id of the workflow deployment

Usage Example

name: Manually Deploy to QA
on:
  workflow_dispatch:
    inputs:
      branchTagOrSha:
        description: 'The branch, tag or sha to deploy '
        required: false

permissions:
  # Required for the create-github-deployment action
  deployments: write

jobs:
  environment: 'QA'
  deploy-different-ways:
    runs-on: [ubuntu-20.04]
    steps:
      - uses: actions/checkout@v3

      - id: deploy-to-qa
        continue-on-error: true  #Setting to true so the deployment board can be updated, even if this fails
        run: |
          ./deploy-to-qa.sh

        # Defaults to using github-actions for the login, regex matching to determine the ref-type and times shown in UTC
      - name: Create GitHub Deployment
        id: defaults
        continue-on-error: true                                      # Setting to true so the job doesn't fail if updating the board fails.
        uses: im-open/create-github-deployment@v1.0.3                # You may also reference just the major or major.minor version
        with:
          workflow-actor: ${{ github.actor }}                        # This will add the user who kicked off the workflow to the deployment payload
          token: ${{ secrets.GITHUB_TOKEN }}                         # If a different token is used, update github-login with the corresponding account
          environment: 'QA'
          release-ref: ${{ github.event.inputs.branchTagOrSha }}
          deploy-status: ${{ steps.deploy-to-qa.outcome }}           # outcome is the result of the step before continue-on-error is applied, i.e. [error|failure|success]
          deployment-description: ${{ steps.deploy-to-qa.outcome }}  # information that may add supporting information to the status/result
          entity: deployments-experiment
          instance: ${{ inputs.instance }}

      ...

Make sure to add permission.deployments=write to ensure the action can create deployments properly

Custom Payload

The deployment.payload is customized to have these values included:

payload: {
  workflow_actor: <<workflow-actor>>,
  entity: <<entity>>,
  instance: <<instance>>,
  workflow_run_url: <<workflow-run-url>>
}

workflow_actor: The GitHub user that initiates the workflow run entity: Used by the Backstage Software Catalog to identify a component or resource instance: The unique deployment target, i.e., "Primary Host", "Secondary Slot 2", or "Failover Server" workflow_url: Generated by the action to represent the workflow run that made the deployment

Contributing

When creating PRs, please review the following guidelines:

The action code does not contain sensitive information.
At least one of the commit messages contains the appropriate +semver: keywords listed under Incrementing the Version for major and minor increments.
The action has been recompiled. See Recompiling Manually for details.
The README.md has been updated with the latest version of the action. See Updating the README.md for details.

Incrementing the Version

This repo uses git-version-lite in its workflows to examine commit messages to determine whether to perform a major, minor or patch increment on merge if source code changes have been made. The following table provides the fragment that should be included in a commit message to active different increment strategies.

Increment Type	Commit Message Fragment
major	+semver:breaking
major	+semver:major
minor	+semver:feature
minor	+semver:minor
patch	default increment type, no comment needed

Source Code Changes

The files and directories that are considered source code are listed in the files-with-code and dirs-with-code arguments in both the build-and-review-pr and increment-version-on-merge workflows.

If a PR contains source code changes, the README.md should be updated with the latest action version and the action should be recompiled. The build-and-review-pr workflow will ensure these steps are performed when they are required. The workflow will provide instructions for completing these steps if the PR Author does not initially complete them.

If a PR consists solely of non-source code changes like changes to the README.md or workflows under ./.github/workflows, version updates and recompiles do not need to be performed.

Recompiling Manually

This command utilizes esbuild to bundle the action and its dependencies into a single file located in the dist folder. If changes are made to the action's source code, the action must be recompiled by running the following command:

# Installs dependencies and bundles the code
npm run build

Updating the README.md

If changes are made to the action's source code, the usage examples section of this file should be updated with the next version of the action. Each instance of this action should be updated. This helps users know what the latest tag is without having to navigate to the Tags page of the repository. See Incrementing the Version for details on how to determine what the next version will be or consult the first workflow run for the PR which will also calculate the next version.

Code of Conduct

This project has adopted the im-open's Code of Conduct.

im-open / create-github-deployment