https://github.com/weirdan/deployment-action

https://github.com/weirdan/deployment-action

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/weirdan/deployment-action
• Owner: weirdan
• License: mit
• Created: 2020-03-09T00:51:09.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-08T14:07:22.000Z (9 months ago)
• Last Synced: 2024-04-08T17:17:54.424Z (9 months ago)
• Language: TypeScript
• Size: 17.8 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# deployment-action

A GitHub action to create

[Deployments](https://developer.github.com/v3/repos/deployments/) as part of

your GitHub CI workflows.

## Action inputs

### `initial_status`

Optional. Initial status for the deployment. Must be one of the [accepted strings](https://developer.github.com/v3/repos/deployments/#create-a-deployment-status)

### `token`

GitHub token.

### `target_url`

Optional. The target URL. This should be the URL of the app once deployed

### `description`

Optional. A description to give the environment

### `auto_merge`

Optional - default is `false`. Whether to attempt to auto-merge the default

branch into the branch that the action is running on if set to `"true"`. More

details in the [GitHub deployments

API](https://developer.github.com/v3/repos/deployments/#parameters-1). Warning -

setting this to `"true"` has caused this action to [fail in some

cases](https://github.com/chrnorm/deployment-action/issues/1)

### `ref`

Optional. The ref to deploy. This can be a branch, tag, or SHA. Defaults to the

last commit of the branch the workflow is triggered for.

## Action outputs

### `deployment_id`

The ID of the deployment as returned by the GitHub API.

## Example usage

```yaml

name: Deploy

on: [push]

jobs:

  deploy:

    name: Deploy my app

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v1

      - uses: weirdan/deployment-action@v1

        name: Create GitHub deployment

        id: deployment

        with:

          token: ${{ github.token }}

          target-url: http://my-app-url.com

          environment: production

        # more steps below where you run your deployment scripts inside the same action

```

## Notes

Heads up! Currently, there is a GitHub Actions limitation where events fired

_inside_ an action will not trigger further workflows. If you use this action

in your workflow, it will **not trigger** any "Deployment" workflows.

A workaround for this is to create the Deployment, perform the deployment

steps, and then trigger an action to create a Deployment Status using my other

action:

[chrnorm/deployment-status](https://github.com/chrnorm/deployment-status).

For example:

```yaml

name: Deploy

on: [push]

jobs:

  deploy:

    name: Deploy my app

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v1

      - uses: chrnorm/deployment-action@releases/v1

        name: Create GitHub deployment

        id: deployment

        with:

          token: ${{ github.token }}

          target-url: http://my-app-url.com

          environment: production

      - name: Deploy my app

        run: |

          # add your deployment code here

      - name: Update deployment status (success)

        if: success()

        uses: chrnorm/deployment-status@releases/v1

        with:

          token: ${{ github.token }}

          target-url: http://my-app-url.com

          state: success

          deployment_id: ${{ steps.deployment.outputs.deployment_id }}

      - name: Update deployment status (failure)

        if: failure()

        uses: chrnorm/deployment-status@releases/v1

        with:

          token: ${{ github.token }}

          target-url: http://my-app-url.com

          state: failure

          deployment_id: ${{ steps.deployment.outputs.deployment_id }}

```