Skip to content

Diffdash version and feedback #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rossme merged 1 commit into from
Jan 25, 2026
Merged

Diffdash version and feedback #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 10 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
```
Expand Down Expand Up @@ -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`:

Expand Down Expand Up @@ -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
```

Expand Down
Loading