https://github.com/deliverybot/deployment-status

GitHub action for updating deployments with status events.
https://github.com/deliverybot/deployment-status

action deployment deployment-automation

Last synced: 15 days ago
JSON representation

GitHub action for updating deployments with status events.

• Host: GitHub
• URL: https://github.com/deliverybot/deployment-status
• Owner: deliverybot
• License: mit
• Created: 2019-08-22T15:11:42.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-11-29T09:56:50.000Z (about 2 years ago)
• Last Synced: 2024-12-06T06:03:50.642Z (16 days ago)
• Topics: action, deployment, deployment-automation
• Language: JavaScript
• Homepage: https://deliverybot.dev
• Size: 386 KB
• Stars: 26
• Watchers: 4
• Forks: 11
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Status Action

Marks a deployment status for GitHub actions.

## Parameters

### Inputs

- `state`: Deployment state. (default: pending)

- `description`: Descriptive message about the deployment state.

- `log-url`: Log url location.

- `token`: Github repository token.

- `environment`: Name for the target deployment environment, which can be changed when setting a deploy status.

- `environment-url`: URL for accessing your environment.

## Example

```yaml

# .github/workflows/deploy.yml

name: Deploy

on: ['deployment']

jobs:

  deployment:

    runs-on: 'ubuntu-latest'

    steps:

    - uses: actions/checkout@v1

    - name: 'use node 8.x'

      uses: actions/setup-node@v1

      with:

        node-version: 8.x

    - name: 'deployment pending'

      uses: 'deliverybot/deployment-status@v1'

      with:

        state: 'pending'

        token: '${{ github.token }}'

    - name: 'deploy'

      run: |

        npm run deploy

    - name: 'deployment success'

      if: success()

      uses: 'deliverybot/deployment-status@v1'

      with:

        state: 'success'

        token: '${{ github.token }}'

    - name: 'deployment failure'

      if: failure()

      uses: 'deliverybot/deployment-status@v1'

      with:

        state: 'failure'

        token: '${{ github.token }}'

```