Skip to content

Commit 9014414

Browse files
authored
Merge pull request #9 from rossme/cursor/diffdash-version-and-feedback-3f7e
Diffdash version and feedback
2 parents cdd6608 + 7b15e67 commit 9014414

1 file changed

Lines changed: 10 additions & 11 deletions

File tree

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -83,16 +83,15 @@ Set these in a `.env` file in your project root:
8383
| `DIFFDASH_GRAFANA_FOLDER_ID` | No | Target folder ID for dashboards |
8484
| `DIFFDASH_OUTPUTS` | No | Comma-separated outputs (default: `grafana`) |
8585
| `DIFFDASH_DRY_RUN` | No | Set to `true` to force dry-run mode |
86+
| `DIFFDASH_APP_NAME` | No | Override app name in dashboard (defaults to Git repo name) |
8687
| `DIFFDASH_PR_DEPLOY_ANNOTATION_EXPR` | No | PromQL expr for PR deployment annotation |
8788

88-
Legacy `GRAFANA_*` env vars are still supported as fallbacks for now.
89-
9089
## Output
9190

9291
When signals are found, JSON is output first, then a summary:
9392

9493
```
95-
[diffdash] v0.4.0
94+
[diffdash] vX.X.X
9695
{ ... dashboard JSON ... }
9796
9897
[diffdash] Dashboard created with 4 panels: 2 logs, 3 counters, 1 gauge, 1 histogram
@@ -103,7 +102,7 @@ When signals are found, JSON is output first, then a summary:
103102
In dry-run mode:
104103

105104
```
106-
[diffdash] v0.4.0
105+
[diffdash] vX.X.X
107106
{ ... dashboard JSON ... }
108107
109108
[diffdash] Dashboard created with 4 panels: 2 logs, 3 counters, 1 gauge, 1 histogram
@@ -113,7 +112,7 @@ In dry-run mode:
113112
**If no signals are found, no dashboard is created:**
114113

115114
```
116-
[diffdash] v0.4.0
115+
[diffdash] vX.X.X
117116
[diffdash] No observability signals found in changed files
118117
[diffdash] Dashboard not created
119118
```
@@ -223,9 +222,9 @@ When `PaymentProcessor` is changed, signals from `BaseProcessor` and `Loggable`
223222
### Setup
224223

225224
1. **Add secrets to your repository:**
226-
- `GRAFANA_URL` - Your Grafana instance URL
227-
- `GRAFANA_TOKEN` - Service Account token with Editor role
228-
- `GRAFANA_FOLDER_ID` (optional) - Folder ID for dashboards
225+
- `DIFFDASH_GRAFANA_URL` - Your Grafana instance URL
226+
- `DIFFDASH_GRAFANA_TOKEN` - Service Account token with Editor role
227+
- `DIFFDASH_GRAFANA_FOLDER_ID` (optional) - Folder ID for dashboards
229228

230229
2. **Create workflow file** `.github/workflows/pr-dashboard.yml`:
231230

@@ -253,9 +252,9 @@ jobs:
253252

254253
- name: Generate dashboard
255254
env:
256-
GRAFANA_URL: ${{ secrets.GRAFANA_URL }}
257-
GRAFANA_TOKEN: ${{ secrets.GRAFANA_TOKEN }}
258-
GRAFANA_FOLDER_ID: ${{ secrets.GRAFANA_FOLDER_ID }}
255+
DIFFDASH_GRAFANA_URL: ${{ secrets.DIFFDASH_GRAFANA_URL }}
256+
DIFFDASH_GRAFANA_TOKEN: ${{ secrets.DIFFDASH_GRAFANA_TOKEN }}
257+
DIFFDASH_GRAFANA_FOLDER_ID: ${{ secrets.DIFFDASH_GRAFANA_FOLDER_ID }}
259258
run: diffdash --verbose
260259
```
261260

0 commit comments

Comments
 (0)