Skip to content

Clarify workflow filename and config source in docs #8

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
efremidze merged 5 commits into from
Jan 24, 2026
Merged

Clarify workflow filename and config source in docs #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
adc1d6c
Clarify workflow and config guidance
efremidze Jan 24, 2026
e1b9cfb
Clarify root config example usage
efremidze Jan 24, 2026
c44c7f0
Update README to clarify configuration file usage
efremidze Jan 24, 2026
213cddd
Update QUICKSTART.md for configuration file instructions
efremidze Jan 24, 2026
ac1e71e
Clarify workflow file naming in README
efremidze Jan 24, 2026
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
2 changes: 1 addition & 1 deletion QUICKSTART.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ publish:

## GitHub Action Usage

Add to `.github/workflows/maintenance.yml`:
Add to `.github/workflows/groundkeeper.yml`:

```yaml
name: Repository Maintenance
Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 (e.g., `.github/workflows/groundkeeper.yml`):

```yaml
name: Repository Maintenance
Expand Down Expand Up @@ -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 by default.

### Schema

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