Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ovotech/montecarlo-monitors-deploy

GitHub Action for deploying Monte Carlo monitors
https://github.com/ovotech/montecarlo-monitors-deploy

Last synced: 12 days ago
JSON representation

GitHub Action for deploying Monte Carlo monitors

Awesome Lists containing this project

README

        

# montecarlo-monitors-deploy

This action provides the following functionality for GitHub Actions users:
- Connect to Monte Carlo
- Performs a dry run of monitors on feature branches (optional)
- Deploys monitors to Monte Carlo (deploys by default, but suggested to only deploy on merge to main)

#### [Monte Carlo Monitors as code docs](https://docs.getmontecarlo.com/docs/monitors-as-code)

## Basic usage

You will first need to generate an API ID and API key, and store these as secrets in your repo.

To use the action as is your YAML monitors will need to live in a folder called `monitors` (this can be overridden)
containing sub-folders by namespace.

```
steps:
- name: MonteCarlo Dry Run Monitors
if: github.ref != 'refs/heads/main'
uses: ovotech/montecarlo-monitors-deploy@v4
with:
MCD_DEFAULT_API_ID: ${{secrets.MCD_DEFAULT_API_ID}}
MCD_DEFAULT_API_TOKEN: ${{secrets.MCD_DEFAULT_API_TOKEN}}
DRY_RUN: 'true'

- name: MonteCarlo Apply Monitors
if: github.ref == 'refs/heads/main'
uses: ovotech/montecarlo-monitors-deploy@v4
with:
MCD_DEFAULT_API_ID: ${{secrets.MCD_DEFAULT_API_ID}}
MCD_DEFAULT_API_TOKEN: ${{secrets.MCD_DEFAULT_API_TOKEN}}
DRY_RUN: 'false'
```