Skip to main content

Automations

Internal bots and automated workflows that run alongside the development process. These are distinct from CI pipelines — they integrate with external tools (ClickUp, GitHub) rather than building or testing code.

ClickUp PR bot​

Automates ClickUp task lifecycle based on GitHub pull request events. When a PR is opened, reviewed, or merged, the bot creates or updates the corresponding ClickUp task to reflect the current state.

Phase 0 note: implementation details (trigger mechanism, ClickUp workspace/list targets, field mappings) to be documented during baseline generation.

Doc-writer agent​

A GitHub Actions bot that drafts documentation pull requests automatically whenever a code PR is merged to main in the backend or frontend repositories.

How it works​

  1. Triggered on pull_request: closed where merged == true and base.ref == main
  2. Reads PR metadata: title, body, author, commits, changed file paths, unified diff
  3. Fetches frontmatter-index.json from the docs site to find which doc pages relate to the changed files
  4. If no pages match: posts a comment on the code PR and exits — no doc PR opened
  5. Calls Claude (Anthropic API) with the diff, PR context, matched pages, and claude-skills/doc-update-skill/SKILL.md as the prompt
  6. Opens a draft PR on the docs repo targeting main, tagged bot-generated, with the code PR author's reviewers assigned
  7. Once a human pushes to the bot branch, the human-edited label is applied and the bot will not overwrite it

Bot behaviour rules​

  • Never blocks a code merge — the workflow only fires after merge
  • Retries up to 3 times on failure (silent on attempts 1–2, comments on the code PR on final failure)
  • Never edits Tier 2 auto-generated directories (reference/backend/api/rest/, reference/backend/pkgsite/, reference/frontend/components/)
  • ../../../../claude-skills/doc-update-skill/SKILL.md — the prompt the bot reads on every run (stub, Issue 09)
  • ../../../../meta/frontmatter-schema.md — defines relates_to globs used for page matching
  • Full implementation spec: .scratch/engineering-docs-foundation/PRD.md §doc-bot workflow