action.yml

name: Create GitHub Deployment
description: Creates a GitHub deployment and deployment status object for deployment tracking by environment, release tag or reference, and deployment instance.

inputs:
  workflow-actor:
    description: The GitHub user who triggered the workflow
    required: true
  token:
    description: 'A token with `repo_deployment` permissions to create and update issues, workflows using this action should be granted `permissions` of `deployments: write`'
    required: true
  environment:
    description: The name of a GitHub environment the release was deployed to, i.e. [Dev|QA|Stage|Demo|UAT|Prod]. It will be set in the standard `environment` property of the deployment object.
    required: true
  release-ref:
    description: The branch, tag or SHA that was deployed
    required: true
  deployment-status:
    description: The status of the deployment, accepted values are [success|error|failure|inactive|in_progress|queued|pending]
    required: true
  deployment-description:
    description: Any description or message about the deployment
    required: false
  entity:
    description: The entity that is deployed, i.e. "proj-app", "proj-infrastruction" or "proj-db"
    required: true
  instance:
    description: 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", "Primary", "Secondary", etc.
    required: true

outputs:
  github-deployment-id:
    description: The id of the GitHub deployment object

runs:
  using: node24
  main: dist/index.js