Action is a wrapper around deployment api.
For detail documentation and explanation refer to:
- GitHub Deployments API
- GitHub Deployments API Create Deployment Section
- GitHub Deployments API Create Deployment Status Section
| Input | Optional | Default | Description |
|---|---|---|---|
| token | No | - | github token |
| deploymentId | Yes | Empty | |
| state | Yes | pending | |
| environmentUrl | Yes | - | |
| requiredContext | Yes | Empty | Format 'value1,value2' |
| autoMerge | Yes | false | |
| environment | Yes | pr-number or qa |
for pull request it default to pr-[number] for push it default to qa |
| transientEnvironment | Yes | false | |
| productionEnvironment | Yes | false |
| Output | Value |
|---|---|
| deploymentId | a deployment number that can be used to set status later |
- uses: kamaz/deploy-action@v1.0
id: deployment
with:
token: ${{ secrets.GITHUB_TOKEN }}
environmentUrl: ${{ format('https://pr-{0}.example.com', github.event.number) }}
#
# Your deployment steps
#
- uses: kamaz/deploy-action@v1.0
if: success()
with:
deploymentId: ${{ steps.deployment.outputs.deploymentId }}
token: ${{ secrets.GITHUB_TOKEN }}
environmentUrl: ${{ format('https://pr-{0}.example.com', github.event.number) }}
state: success
- uses: kamaz/deploy-action@v1.0
if: failure()
with:
deploymentId: ${{ steps.deployment.outputs.deploymentId }}
token: ${{ secrets.GITHUB_TOKEN }}
environmentUrl: ${{ format('https://pr-{0}.example.com', github.event.number) }}
state: failure