Skip to content

Dogfood docmend on its own repo - #14

Merged
dakshcodez merged 1 commit into
mainfrom
add-dogfood-workflow
Aug 15, 2026
Merged

Dogfood docmend on its own repo#14
dakshcodez merged 1 commit into
mainfrom
add-dogfood-workflow

Conversation

@dakshcodez

Copy link
Copy Markdown
Owner

Summary

Adds .github/workflows/docmend.yml so the repo runs its own tool on its own PRs. Triggers on pull_request for changes under packages/*/src/** or any *.md file — restricted rather than every PR, given the real free-tier rate-limit/quota costs measured in TESTING.md's Phase 5 testing (no reason to re-index on a PR that only touches, say, this workflow file itself).

References the action locally (uses: ./) rather than owner/repo@v1, since there's no published tag yet and this always tests the current branch's code, not a possibly-stale published version.

Requires (not part of this PR)

A GEMINI_API_KEY repository secret, added via the GitHub web UI (Settings -> Secrets and variables -> Actions) - deliberately not something to set up via any CLI mechanism in this session, given the earlier incident where a key typed through a shell command ended up in the visible conversation transcript.

Test plan

  • Validated the workflow file is syntactically valid YAML
  • npm run lint / typecheck / build (existing ci.yml) all pass
  • The new workflow's actual trigger can't be exercised by this PR itself (it only touches .github/workflows/, matching neither path filter) - real verification happens on the next PR that touches source or docs after this merges

Adds .github/workflows/docmend.yml, triggering on pull_request for
changes under packages/*/src/** or any *.md file. References the
action locally (uses: ./) rather than a published owner/repo@ref,
since it's the same repo and there's no published v1 tag yet - this
also means every PR always tests against the action's current code
on that branch, not a potentially-stale published version.

Restricted the trigger to source/doc-touching paths rather than
every PR, given how real the free-tier rate-limit and quota costs
turned out to be during the Phase 5 real-repo testing (TESTING.md) -
no reason to burn embedding calls re-indexing on a PR that only
touches, say, CI config.

Requires a GEMINI_API_KEY repository secret to actually run, which
isn't something to set up from here - left to be added via the
GitHub web UI (Settings > Secrets and variables > Actions) rather
than any CLI mechanism, given the earlier incident this session
where a key typed via a shell command ended up in the visible
conversation transcript.

Validated the workflow file is syntactically valid YAML. The actual
trigger path can't be exercised by this PR itself, since it only
touches .github/workflows/ (matching neither path filter) - real
end-to-end verification happens naturally on the next PR that
touches source or docs after this merges.
@dakshcodez
dakshcodez merged commit 7378bd6 into main Aug 15, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant