https://github.com/alexcnichols/create-deployment

An Action to create deployments via the GitHub Deployment API
https://github.com/alexcnichols/create-deployment

actions deployment deployment-automation github github-actions

Last synced: 27 days ago
JSON representation

An Action to create deployments via the GitHub Deployment API

• Host: GitHub
• URL: https://github.com/alexcnichols/create-deployment
• Owner: alexcnichols
• License: mit
• Created: 2019-11-15T03:12:26.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T13:16:59.000Z (almost 2 years ago)
• Last Synced: 2024-10-31T10:48:12.489Z (about 2 months ago)
• Topics: actions, deployment, deployment-automation, github, github-actions
• Language: JavaScript
• Homepage:
• Size: 1 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub Action - Deployments API

This GitHub Action (written in JavaScript) wraps the [GitHub Deployment API](https://developer.github.com/v3/repos/deployments/), specifically the [Create a deployment](https://developer.github.com/v3/repos/deployments/#create-a-deployment) endpoint, to allow you to leverage GitHub Actions to create deployments.



## Usage

### Pre-requisites

Create a workflow `.yml` file in your repository's `.github/workflows` directory. An [example workflow](#example-workflow---create-a-deployment) is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).

### Inputs

For more information on these inputs, see the [API Documentation](https://developer.github.com/v3/repos/deployments/#create-a-deployment)

- `environment`: Name for the target deployment environment (e.g., `production`, `staging`, `qa`). Default: `production`

### Outputs

For more information on these outputs, see the [API Documentation](https://developer.github.com/v3/repos/deployments/#create-a-deployment) for an example of what these outputs look like

- `id`: The deployment ID

### Example workflow - create a deployment

On every `push` to a tag matching the pattern `v*`, [create a deployment](https://developer.github.com/v3/repos/deployments/#create-a-deployment):

```yaml

on:

  push:

    # Sequence of patterns matched against refs/tags

    tags:

      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10

name: Create Deployment

jobs:

  build:

    name: Create Deployment

    runs-on: ubuntu-latest

    steps:

      - name: Checkout code

        uses: actions/checkout@master

      - name: Create Deployment

        id: create_deployment

        uses: alexcnichols/create-deployment@v1

        env:

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token

        with:

          environment: production

```

This will create a [Deployment](https://help.github.com/en/github/administering-a-repository/viewing-deployment-activity-for-your-repository). This uses the `GITHUB_TOKEN` provided by the [virtual environment](https://help.github.com/en/github/automating-your-workflow-with-github-actions/virtual-environments-for-github-actions#github_token-secret), so no new token is needed.

## Contributing

We would love you to contribute to `@alexcnichols/create-deployment`, pull requests are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

## License

The scripts and documentation in this project are released under the [MIT License](LICENSE).