Skip to content

[plan] Create WorkQueueOps and BatchOps pattern documentation pages #25059

Description

@github-actions

Objective

Create two new documentation pages covering work-queue and batch operation patterns for agentic workflows.

Context

Issue #22001 has been open since March 2026. The docs/src/content/docs/patterns/ directory contains daily-ops.md, issue-ops.md, and task-ops.md but has no coverage for work-queue or batch processing patterns — a common agentic use case.

Files to Create

  • docs/src/content/docs/patterns/workqueue-ops.md — work-queue patterns
  • docs/src/content/docs/patterns/batch-ops.md — batch operation patterns

Update the patterns index/sidebar if one exists.

Approach

workqueue-ops.md — Work Queue Operations

Document approaches for processing a queue of work items:

  1. Issue checklist as queue: use GitHub issue checkboxes as a simple work queue; agent checks off items as it processes them
  2. Sub-issues as queue: create sub-issues per work item; process open ones, close when done
  3. Cache-memory queue: store queue state in cache-memory JSON, process items across runs
  4. Discussion-based queue: use GitHub Discussions to track pending work

Include: when to use each approach, a complete workflow example (frontmatter + prompt), and caveats (concurrency, idempotency).

batch-ops.md — Batch Operations

Document strategies for processing large batches:

  1. Chunked processing: split work into pages/batches using GITHUB_RUN_NUMBER or timestamps
  2. Fan-out with matrix: use GitHub Actions matrix to parallelize batch jobs
  3. Rate-limit-aware batching: throttle API calls in batch workflows
  4. Result aggregation: collect results from batch runs back into a summary issue or report

Include: when to use batch vs sequential processing, error handling (partial failures), and a complete example for a real-world scenario (e.g., updating labels across 100+ issues).

Acceptance Criteria

  • workqueue-ops.md is created and covers at least 3 queue strategies with examples
  • batch-ops.md is created and covers at least 3 batch strategies with examples
  • Each page has at least one complete working workflow example (frontmatter + prompt)
  • Pages are linked from the patterns sidebar/index
  • Cross-links exist between workqueue-ops.md, batch-ops.md, and related pages (task-ops.md, cache-memory.md, repo-memory.md)
    Related to [Daily Report] Documentation Quality Report — April 7, 2026 #25041

Generated by Plan Command for issue #25041 · ● 360.6K ·

  • expires on Apr 9, 2026, 10:34 AM UTC

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions