https://github.com/atatus/deployment-marker-action

Github Action for recording a Deployment Marker in Atatus
https://github.com/atatus/deployment-marker-action

Last synced: 23 days ago
JSON representation

Github Action for recording a Deployment Marker in Atatus

• Host: GitHub
• URL: https://github.com/atatus/deployment-marker-action
• Owner: atatus
• License: apache-2.0
• Created: 2024-11-09T12:55:03.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-12T09:45:51.000Z (29 days ago)
• Last Synced: 2024-12-12T10:26:04.743Z (29 days ago)
• Language: TypeScript
• Size: 466 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Atatus Application Deployment Marker

A GitHub Action to add Atatus deployment markers during your release pipeline.

## Inputs

| Key              | Required | Default | Description |

| ---------------- | -------- | ------- | ----------- |

| `apiKey`         | **yes**  | -       | [See here](https://docs.atatus.com/docs/faq/basics-faq/where-to-find-api-key.html) to locate the API key |

| `projectId`      | **yes**       | -       | A unique identifier for a project. [See here](https://docs.atatus.com/docs/faq/basics-faq/where-to-find-the-project-id.html) to locate the Project ID. |

| `revision`         | **yes**      | -       | Revision being deployed, such as a Git SHA or version. |

| `releaseStage`    | **yes**       | -       | Release stage of the deployment Example, production and staging. |

| `changes`       | no       | -       | Change log or comments to record with this deploy. |

| `user`           | no  | `github.actor` | The name of the user who deployed. |

## Example usage

### GitHub secrets

[Github secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#about-encrypted-secrets) assumed to be set:

* `ATATUS_API_KEY` - API Key (Type - Application Key, Scope - Write)

* `ATATUS_PROJECT_ID` - A unique identifier for a project

>*There are a number of [default GitHub environment variables](https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables) that are used in these examples as well.*

### Minimum required fields

```yaml

name: Atatus Deployment Tracker

on:

  push:

    tags:

      - 'v*.*.*'

jobs:

  atatus:

    runs-on: ubuntu-latest

    name: Atatus

    steps:

      - name: Set Release Version from Tag

        run: echo "RELEASE_VERSION=${{ github.ref_name }}" >> $GITHUB_ENV

      - name: Atatus Application Deployment Marker

        uses: atatus/[email protected]

        with:

          apiKey: ${{ secrets.ATATUS_API_KEY }}

          projectId: ${{ secrets.ATATUS_PROJECT_ID }}

          revision: ${{ env.RELEASE_VERSION || github.run_number }}

          releaseStage: 'production'

          changes: ${{ github.sha }}

          user: ${{ github.actor }}

```