https://github.com/elmahio/github-create-deployment-action

GitHub Action to create a new deployment on elmah.io
https://github.com/elmahio/github-create-deployment-action

actions deployment deployment-tools deployment-tracker elmah-io error-monitoring github-action github-actions

Last synced: about 2 months ago
JSON representation

GitHub Action to create a new deployment on elmah.io

• Host: GitHub
• URL: https://github.com/elmahio/github-create-deployment-action
• Owner: elmahio
• Created: 2021-08-10T11:26:34.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-09T07:57:45.000Z (about 2 years ago)
• Last Synced: 2024-04-28T02:38:34.211Z (8 months ago)
• Topics: actions, deployment, deployment-tools, deployment-tracker, elmah-io, error-monitoring, github-action, github-actions
• Language: Dockerfile
• Homepage: https://docs.elmah.io/create-deployments-from-github-actions/
• Size: 8.79 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# elmah.io Create Deployment Action

GitHub Action to create a new deployment on elmah.io.

For the full documentation check out [Create deployments from GitHub Actions](https://docs.elmah.io/create-deployments-from-github-actions/).

## Inputs

## `apiKey`

**Required** An API key with permission to create deployments.

## `version`

**Required** The version number of this deployment. The value of version can be a SemVer compliant string or any other syntax that you are using as your version numbering scheme.

## `description`

Optional description of this deployment. Can be markdown or clear text.

## `userName`

The name of the person responsible for creating this deployment. This can be the name taken from your deployment server.

## `userEmail`

The email of the person responsible for creating this deployment. This can be the email taken from your deployment server.

## `logId`

As default, deployments are attached all logs of the organization. If you want a deployment to attach to a single log only, set this to the ID of that log.

## Example usage

Minimum example:

```yml

uses: elmahio/github-create-deployment-action@v1

with:

  apiKey: ${{ secrets.ELMAH_IO_API_KEY }}

  version: '1.0.0'

```

Example with more input and GitHub variables:

```yml

uses: elmahio/github-create-deployment-action@v1

with:

  apiKey: ${{ secrets.ELMAH_IO_API_KEY }}

  description: ${{ github.event.head_commit.message }}

  version: ${{ github.run_number }}

  userName: ${{ github.actor }}

  logId: ${{ secrets.ELMAH_IO_LOG_ID }}

```