"Oction" is a GitHub Action that implements a single call with @octokit/request allowing easy interaction with GitHub REST APIs from your workflow.
Original documentation: https://developer.github.com/v3/repos/deployments/#create-a-deployment-status
This action implements POST request to /repos/{owner}/{repo}/deployments/{deployment_id}/statuses
- uses: maxkomarychev/oction-create-deployment-status@v0.7.1
id: my_step_id
with:
token: <token value>
deployment_id: <deployment_id value>
state: <state value>
- name: Print outputs
run: |
echo ${{ steps.my_step_id.outputs.id }}
echo ${{ steps.my_step_id.outputs.number }}| Name | Is required | Description |
|---|---|---|
| token | true | Token to authenticate the request |
| owner | false | owner parameter |
| repo | false | repo parameter |
| deployment_id | true | deployment_id parameter |
| state | true | The state of the status. Can be one of error, failure, inactive, in_progress, queued pending, or success. Note: To use the inactive state, you must provide the application/vnd.github.ant-man-preview+json custom media type. To use the in_progress and queued states, you must provide the application/vnd.github.flash-preview+json custom media type. |
| target_url | false | The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url. |
| log_url | false | The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: "" Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. |
| description | false | A short description of the status. The maximum description length is 140 characters. |
| environment | false | Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa. Note: This parameter requires you to use the application/vnd.github.flash-preview+json custom media type. |
| environment_url | false | Sets the URL for accessing your environment. Default: "" Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. |
| auto_inactive | false | Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true Note: To add an inactive status to production environments, you must use the application/vnd.github.flash-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. |
| Name | Description |
|---|---|
| id | id field of the response (if exists) |
| number | number field of the response (if exists) |