From adc1d6cad123344200b532ec61be5af601551336 Mon Sep 17 00:00:00 2001 From: Lasha Efremidze Date: Sat, 24 Jan 2026 00:41:40 -0800 Subject: [PATCH 1/5] Clarify workflow and config guidance --- QUICKSTART.md | 4 ++-- README.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/QUICKSTART.md b/QUICKSTART.md index 4a37540..68039f7 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -38,7 +38,7 @@ groundkeeper run --config .github/agent.yml --directory . ## Configuration File -Create `.github/agent.yml` in your repository root and validate it against `packages/schemas/agent.schema.json`: +Create `.github/agent.yml` in your repository root and validate it against `packages/schemas/agent.schema.json`. This file is the source of truth for the CLI and Action (other example configs like a root `groundkeeper.yml` are not used): ```yaml $schema: ../packages/schemas/agent.schema.json @@ -75,7 +75,7 @@ publish: ## GitHub Action Usage -Add to `.github/workflows/maintenance.yml`: +Add to `.github/workflows/groundkeeper.yml` (the filename is flexible; this is the convention used in this repo): ```yaml name: Repository Maintenance diff --git a/README.md b/README.md index 2fca9da..0014438 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ npm install -g groundkeeper ### As a GitHub Action -Add to your workflow file (e.g., `.github/workflows/maintenance.yml`): +Add to your workflow file (the filename is flexible; this repo uses `.github/workflows/groundkeeper.yml`): ```yaml name: Repository Maintenance @@ -116,7 +116,7 @@ Options: ## Configuration -The configuration file is validated against `packages/schemas/agent.schema.json`. +The configuration file is validated against `packages/schemas/agent.schema.json`. Groundkeeper reads `.github/agent.yml` as the source of truth; other example configs (like the legacy `groundkeeper.yml` at the repo root) are not used by the CLI or Action. ### Schema @@ -190,7 +190,7 @@ cat .groundkeeper/report.md ### Run in CI/CD ```yaml -# .github/workflows/maintenance.yml +# .github/workflows/groundkeeper.yml name: Weekly Maintenance on: schedule: From e1b9cfb2dc7d78cab250cc221fe059e0cfc057e0 Mon Sep 17 00:00:00 2001 From: Lasha Efremidze Date: Sat, 24 Jan 2026 00:42:41 -0800 Subject: [PATCH 2/5] Clarify root config example usage --- QUICKSTART.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/QUICKSTART.md b/QUICKSTART.md index 68039f7..083bfb1 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -38,7 +38,7 @@ groundkeeper run --config .github/agent.yml --directory . ## Configuration File -Create `.github/agent.yml` in your repository root and validate it against `packages/schemas/agent.schema.json`. This file is the source of truth for the CLI and Action (other example configs like a root `groundkeeper.yml` are not used): +Create `.github/agent.yml` in your repository root and validate it against `packages/schemas/agent.schema.json`. This file is the source of truth for the CLI and Action by default; the root `groundkeeper.yml` is an example config and only used if you pass it explicitly with `--config`: ```yaml $schema: ../packages/schemas/agent.schema.json diff --git a/README.md b/README.md index 0014438..6a487be 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ Options: ## Configuration -The configuration file is validated against `packages/schemas/agent.schema.json`. Groundkeeper reads `.github/agent.yml` as the source of truth; other example configs (like the legacy `groundkeeper.yml` at the repo root) are not used by the CLI or Action. +The configuration file is validated against `packages/schemas/agent.schema.json`. Groundkeeper reads `.github/agent.yml` as the source of truth by default; the root `groundkeeper.yml` is an example config and only used if you pass it explicitly with `--config`. ### Schema From c44c7f08750a2b38eca2b106437788edf00e7942 Mon Sep 17 00:00:00 2001 From: Lasha Efremidze Date: Sat, 24 Jan 2026 00:43:51 -0800 Subject: [PATCH 3/5] Update README to clarify configuration file usage Removed mention of the root `groundkeeper.yml` as an example config. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6a487be..048e806 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ Options: ## Configuration -The configuration file is validated against `packages/schemas/agent.schema.json`. Groundkeeper reads `.github/agent.yml` as the source of truth by default; the root `groundkeeper.yml` is an example config and only used if you pass it explicitly with `--config`. +The configuration file is validated against `packages/schemas/agent.schema.json`. Groundkeeper reads `.github/agent.yml` as the source of truth by default. ### Schema From 213cddd3b73d35100b8ca5428cead3fcdda30015 Mon Sep 17 00:00:00 2001 From: Lasha Efremidze Date: Sat, 24 Jan 2026 00:44:41 -0800 Subject: [PATCH 4/5] Update QUICKSTART.md for configuration file instructions Clarified instructions for creating configuration files. --- QUICKSTART.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/QUICKSTART.md b/QUICKSTART.md index 083bfb1..6e32af5 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -38,7 +38,7 @@ groundkeeper run --config .github/agent.yml --directory . ## Configuration File -Create `.github/agent.yml` in your repository root and validate it against `packages/schemas/agent.schema.json`. This file is the source of truth for the CLI and Action by default; the root `groundkeeper.yml` is an example config and only used if you pass it explicitly with `--config`: +Create `.github/agent.yml` in your repository root and validate it against `packages/schemas/agent.schema.json`: ```yaml $schema: ../packages/schemas/agent.schema.json @@ -75,7 +75,7 @@ publish: ## GitHub Action Usage -Add to `.github/workflows/groundkeeper.yml` (the filename is flexible; this is the convention used in this repo): +Add to `.github/workflows/groundkeeper.yml`: ```yaml name: Repository Maintenance From ac1e71ea574750802bbc48a1ff42459d291b27a9 Mon Sep 17 00:00:00 2001 From: Lasha Efremidze Date: Sat, 24 Jan 2026 00:45:15 -0800 Subject: [PATCH 5/5] Clarify workflow file naming in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 048e806..fcd1fc8 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ npm install -g groundkeeper ### As a GitHub Action -Add to your workflow file (the filename is flexible; this repo uses `.github/workflows/groundkeeper.yml`): +Add to your workflow file (e.g., `.github/workflows/groundkeeper.yml`): ```yaml name: Repository Maintenance