Skip to content

Commit

Permalink
Merge pull request #5 from ovotech/readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
chloecovo committed Aug 30, 2023
2 parents 96e6454 + df66026 commit 0ca72b8
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
4 changes: 1 addition & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,4 @@ cython_debug/
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
.idea/

.local_monitor/
.idea/
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

This action provides the following functionality for GitHub Actions users:
- Connect to Monte Carlo
- Performs a dry run of monitors on feature branches
- Deploys monitors when merged to main branch
- 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)

Expand All @@ -12,21 +12,22 @@ This action provides the following functionality for GitHub Actions users:
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.
containing sub-folders by namespace.


```
steps:
- name: MonteCarlo Dry Run Monitors
if: github.ref != 'refs/heads/main'
uses: actions/montecarlo-monitors-deploy@v1
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: actions/montecarlo-monitors-deploy@v1
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}}
Expand Down

0 comments on commit 0ca72b8

Please sign in to comment.