From e97c1058f95199f3b66a583185fda3594d63dd08 Mon Sep 17 00:00:00 2001
From: Robert Lin Simple Example
From 24c295a34785eba29719747ccfa211800a6baaaf Mon Sep 17 00:00:00 2001
From: Robert Lin Simple Push Example
@@ -96,7 +105,7 @@ jobs:
deploy:
steps:
- name: start deployment
- uses: bobheadxi/deployments@v0.6.2
+ uses: bobheadxi/deployments@v1
id: deployment
with:
step: start
@@ -122,15 +131,15 @@ on:
jobs:
deploy:
+ runs-on: ubuntu-latest
steps:
- name: start deployment
- uses: bobheadxi/deployments@v0.6.2
+ uses: bobheadxi/deployments@v1
id: deployment
with:
step: start
token: ${{ secrets.GITHUB_TOKEN }}
env: integration
- ref: ${{ github.head_ref }}
- name: do my deploy
# ...
@@ -148,18 +157,14 @@ This is best used after `step: start` and should follow whatever deployment task

-The following [`inputs`](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstepswith) are available:
+In addition to the [core configuration](#configuration), the following [`inputs`](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstepswith) are available:
-| Variable | Default | Purpose |
-| --------------- | --------------------------- | --------------------------------------------------------------------------------- |
-| `step` | | must be `finish` for this step |
-| `token` | | provide your `${{ secrets.GITHUB_TOKEN }}` for API access |
-| `logs` | URL to GitHub commit checks | URL of your deployment logs |
-| `desc` | | description for this deployment |
-| `status` | | provide the current deployment job status `${{ job.status }}` |
-| `deployment_id` | | identifier for deployment to update (see outputs of [`step: start`](#step-start)) |
-| `env_url` | | URL to view deployed environment |
-| `auto_inactive` | `true` | Mark previous non-transient deployments as `inactive` |
+| Variable | Default | Purpose |
+| --------------- | ------- | --------------------------------------------------------------------------------- |
+| `status` | | provide the current deployment job status `${{ job.status }}` |
+| `deployment_id` | | identifier for deployment to update (see outputs of [`step: start`](#step-start)) |
+| `env_url` | | URL to view deployed environment |
+| `override` | `true` | whether to mark existing deployments of this environment as inactive |
Simple Example
@@ -178,12 +183,13 @@ jobs:
# ...
- name: update deployment status
- uses: bobheadxi/deployments@v0.6.2
+ uses: bobheadxi/deployments@v1
if: always()
with:
step: finish
token: ${{ secrets.GITHUB_TOKEN }}
status: ${{ job.status }}
+ env: ${{ steps.deployment.outputs.env }}
deployment_id: ${{ steps.deployment.outputs.deployment_id }}
```
@@ -199,15 +205,7 @@ This step can be used to automatically shut down deployments you create on pull

-The following [`inputs`](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstepswith) are available:
-
-| Variable | Default | Purpose |
-| -------- | --------------------------- | -------------------------------------------------------------------------- |
-| `step` | | must be `deactivate-env` for this step |
-| `token` | | provide your `${{ secrets.GITHUB_TOKEN }}` for API access |
-| `logs` | URL to GitHub commit checks | URL of your deployment logs |
-| `desc` | | description for this deployment |
-| `env` | | identifier for environment to deploy to (e.g. `staging`, `prod`, `main`) |
+Refer to the [core configuration](#configuration) for available [`inputs`](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstepswith).
Simple Example
@@ -233,21 +231,49 @@ jobs:
# ...
- name: mark environment as deactivated
- uses: bobheadxi/deployments@v0.6.2
+ uses: bobheadxi/deployments@v1
with:
step: deactivate-env
token: ${{ secrets.GITHUB_TOKEN }}
env: ${{ steps.get_branch.outputs.branch }}
- desc: Deployment was pruned
+ desc: Environment was pruned
```