https://github.com/mikaelvesavuori/dorametrix-action

Conveniently call Dorametrix to create a deployment event through a GitHub Action.
https://github.com/mikaelvesavuori/dorametrix-action

devops dora dora-metrics dorametrix quality software-delivery software-quality

Last synced: 2 months ago
JSON representation

Conveniently call Dorametrix to create a deployment event through a GitHub Action.

• Host: GitHub
• URL: https://github.com/mikaelvesavuori/dorametrix-action
• Owner: mikaelvesavuori
• License: mit
• Created: 2022-02-07T19:14:07.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-06-11T19:21:59.000Z (over 1 year ago)
• Last Synced: 2024-09-24T04:45:56.500Z (3 months ago)
• Topics: devops, dora, dora-metrics, dorametrix, quality, software-delivery, software-quality
• Language: Shell
• Homepage: https://github.com/marketplace/actions/dorametrix
• Size: 22.5 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# Dorametrix GitHub action

Conveniently call [Dorametrix](https://github.com/mikaelvesavuori/dorametrix) to create a deployment event.

Looking for a demo? In that case you might be interested in the [Dorametrix Pipe demo](https://github.com/mikaelvesavuori/demo-dorametrix-pipe).

## Setup and usage

You need to set two required secrets—`DORAMETRIX_ENDPOINT` and `DORAMETRIX_API_KEY`—in accordance with the overall [Dorametrix](https://github.com/mikaelvesavuori/dorametrix) requirements.

### Remember...

- Always ensure you have secure settings regarding what actions you allow.

- Note that Dorametrix will _not_ work without access to the Git history (i.e. `with.fetch-depth: 0`).

## Required input and output arguments

### `endpoint`

Dorametrix API endpoint, in the format `https://mydomain.com/stagename`.

### `api-key`

Dorametrix API token.

## Optional input and output arguments

### `product`

The product name can be optionally set. If not, it will default to the repository name.

## Secrets the action uses

This Action uses two secrets: `DORAMETRIX_ENDPOINT` and `DORAMETRIX_API_KEY`, as described above.

## Environment variables the action uses

If the product name is not set, Dorametrix will use `${{ github.event.repository.name }}` to grab the repository name.

## An example of how to use this action in a workflow

```yml

on: [push]

jobs:

  dorametrix:

    runs-on: ubuntu-latest

    name: Dorametrix

    steps:

      - name: Checkout

        uses: actions/checkout@v2

        with:

          fetch-depth: 0

      - name: dorametrix

        uses: mikaelvesavuori/dorametrix-action@v3

        with:

          endpoint: ${{ secrets.DORAMETRIX_ENDPOINT }}

          api-key: ${{ secrets.DORAMETRIX_API_KEY }}

```