Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bitnovus authored Dec 14, 2023
1 parent 29de418 commit 4083be5
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
**NOTE:** The half-completed version still seems helpful since existing services don't seem to support Heroku out of the box. (e.g, [FourKeys](https://github.com/GoogleCloudPlatform/fourkeys), [Sleuth](https://www.sleuth.io/), [LinearB](https://linearb.io/)).

> [!WARNING]
> YMMV
# accelerate-metrics

A GitHub action to calculate [DevOps Research & Assessment](https://www.devops-research.com/research.html) (DORA) metrics from Heroku release data.
Expand Down Expand Up @@ -30,15 +33,15 @@ Make sure to add `HEROKU_API_TOKEN` to your GitHub secrets. It needs to have rea
```yaml
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Generate Accelerate Metrics
uses: sbrudz/accelerate-metrics@v1
uses: JerichoSecurity/accelerate-metrics@main
with:
heroku_api_token: ${{ secrets.HEROKU_API_TOKEN }}
heroku_app_name: "your-app-name"
- uses: actions/upload-artifact@v2
- uses: actions/upload-artifact@v4
name: Store metrics report
with:
name: accelerate-metrics-report
Expand Down Expand Up @@ -105,7 +108,7 @@ The challenge is that "degraded service" will likely mean different things for d
Prerequisites:
- node.js >= 12.14
- node.js >= 20.10
Setup:
Expand Down

0 comments on commit 4083be5

Please sign in to comment.