im-open/Create GitHub Deployment
Creates a GitHub deployment and deployment status object for deployment tracking by environment, release tag or reference, and deployment instance.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| workflow-actor | The GitHub user who triggered the workflow | yes | — |
| token | A token with `repo_deployment` permissions to create and update issues, workflows using this action should be granted `permissions` of `deployments: write` | yes | — |
| environment | 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. | yes | — |
| release-ref | The branch, tag or SHA that was deployed | yes | — |
| deployment-status | The status of the deployment, accepted values are [success|error|failure|inactive|in_progress|queued|pending] | yes | — |
| deployment-description | Any description or message about the deployment | no | — |
| entity | The entity that is deployed, i.e. "proj-app", "proj-infrastruction" or "proj-db" | yes | — |
| instance | 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. | yes | — |
Outputs
| name | description |
|---|---|
| github-deployment-id | The id of the GitHub deployment object |