From 7b15e67cf28b72b0531e30f1f9faa60fa839392e Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Sun, 25 Jan 2026 11:34:22 +0000 Subject: [PATCH] Update README: use generic version, remove legacy env var references - Change version references from v0.4.0 to vX.X.X - Remove backward compatibility note for legacy GRAFANA_* env vars - Update GitHub Actions example to use DIFFDASH_* prefixed env vars - Add missing DIFFDASH_APP_NAME to environment variables table Co-authored-by: r.buddie --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 98b3c9b..80d588b 100644 --- a/README.md +++ b/README.md @@ -83,16 +83,15 @@ Set these in a `.env` file in your project root: | `DIFFDASH_GRAFANA_FOLDER_ID` | No | Target folder ID for dashboards | | `DIFFDASH_OUTPUTS` | No | Comma-separated outputs (default: `grafana`) | | `DIFFDASH_DRY_RUN` | No | Set to `true` to force dry-run mode | +| `DIFFDASH_APP_NAME` | No | Override app name in dashboard (defaults to Git repo name) | | `DIFFDASH_PR_DEPLOY_ANNOTATION_EXPR` | No | PromQL expr for PR deployment annotation | -Legacy `GRAFANA_*` env vars are still supported as fallbacks for now. - ## Output When signals are found, JSON is output first, then a summary: ``` -[diffdash] v0.4.0 +[diffdash] vX.X.X { ... dashboard JSON ... } [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: In dry-run mode: ``` -[diffdash] v0.4.0 +[diffdash] vX.X.X { ... dashboard JSON ... } [diffdash] Dashboard created with 4 panels: 2 logs, 3 counters, 1 gauge, 1 histogram @@ -113,7 +112,7 @@ In dry-run mode: **If no signals are found, no dashboard is created:** ``` -[diffdash] v0.4.0 +[diffdash] vX.X.X [diffdash] No observability signals found in changed files [diffdash] Dashboard not created ``` @@ -223,9 +222,9 @@ When `PaymentProcessor` is changed, signals from `BaseProcessor` and `Loggable` ### Setup 1. **Add secrets to your repository:** - - `GRAFANA_URL` - Your Grafana instance URL - - `GRAFANA_TOKEN` - Service Account token with Editor role - - `GRAFANA_FOLDER_ID` (optional) - Folder ID for dashboards + - `DIFFDASH_GRAFANA_URL` - Your Grafana instance URL + - `DIFFDASH_GRAFANA_TOKEN` - Service Account token with Editor role + - `DIFFDASH_GRAFANA_FOLDER_ID` (optional) - Folder ID for dashboards 2. **Create workflow file** `.github/workflows/pr-dashboard.yml`: @@ -253,9 +252,9 @@ jobs: - name: Generate dashboard env: - GRAFANA_URL: ${{ secrets.GRAFANA_URL }} - GRAFANA_TOKEN: ${{ secrets.GRAFANA_TOKEN }} - GRAFANA_FOLDER_ID: ${{ secrets.GRAFANA_FOLDER_ID }} + DIFFDASH_GRAFANA_URL: ${{ secrets.DIFFDASH_GRAFANA_URL }} + DIFFDASH_GRAFANA_TOKEN: ${{ secrets.DIFFDASH_GRAFANA_TOKEN }} + DIFFDASH_GRAFANA_FOLDER_ID: ${{ secrets.DIFFDASH_GRAFANA_FOLDER_ID }} run: diffdash --verbose ```