Skip to content

Update campaign docs: fix discovery/allowed distinction, rename lifecycle page#11361

Merged
mnkiefer merged 7 commits intomainfrom
copilot/update-campaign-docs
Jan 22, 2026
Merged

Update campaign docs: fix discovery/allowed distinction, rename lifecycle page#11361
mnkiefer merged 7 commits intomainfrom
copilot/update-campaign-docs

Conversation

Copy link
Contributor

Copilot AI commented Jan 22, 2026

Campaign documentation incorrectly conflated discovery-repos/discovery-orgs (search scope) with allowed-repos/allowed-orgs (operation scope). The spec page also lacked required field documentation matching pkg/campaign/validation.go.

Changes

Campaign Spec page (specs.md)

  • Clarified field semantics:
    • discovery-*: WHERE to search for worker-created issues/PRs (required when using workflows or tracker-label)
    • allowed-*: WHERE campaign can operate (optional, defaults to current repo)
  • Updated example with required KPI fields (baseline, target, time-window-days) and YAML frontmatter delimiters
  • Reorganized fields into Required / Required for discovery / Commonly used / Optional sections
  • Removed duplicate "Governance (pacing)" heading

Lifecycle page rename

  • flow.mdlifecycle.md
  • Title: "Campaign Flow & Lifecycle" → "Campaign Lifecycle"
  • Updated navigation config and all internal references

Example

Before (incorrect):

# Optional: Repositories this campaign can operate on
allowed-repos:
  - "myorg/service-a"

After (correct):

# Discovery: Where to find worker-created issues/PRs (required with workflows)
discovery-repos:
  - "myorg/service-a"

# Optional: Restrict where campaign can operate (defaults to current repo)
# allowed-repos:
#   - "myorg/service-a"
Original prompt

Update campaign docs according to actual implementation. Make sure the Campaign Spec page is up to date and rename the "Flow & lifecycle" page to just Campaign lifecycle (draw inspiration from https://github.com/githubnext/gh-aw/blob/481f56df77fe841a905448f829618b5c501db6fe/docs/src/content/docs/guides/campaigns/architecture.md)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 4 commits January 22, 2026 17:48
Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
- Updated Campaign Spec page with accurate field descriptions
- Fixed discovery-repos/discovery-orgs vs allowed-repos/allowed-orgs confusion
- Added required fields section for discovery configuration
- Updated KPI section with all required fields (baseline, target, time-window-days)
- Added proper YAML frontmatter delimiters to examples
- Removed duplicate governance section
- Renamed "Campaign Flow & Lifecycle" to "Campaign Lifecycle"
- Updated all references from /flow/ to /lifecycle/

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
The example includes all commonly-used fields and represents a complete, working
campaign configuration rather than a truly minimal one. This is more useful for
users getting started.

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
@mnkiefer mnkiefer marked this pull request as ready for review January 22, 2026 17:57
Copilot AI changed the title [WIP] Update campaign documentation to reflect actual implementation Update campaign docs: fix discovery/allowed distinction, rename lifecycle page Jan 22, 2026
Copilot AI requested a review from mnkiefer January 22, 2026 17:59
@mnkiefer mnkiefer merged commit 5526346 into main Jan 22, 2026
2 checks passed
@mnkiefer mnkiefer deleted the copilot/update-campaign-docs branch January 22, 2026 18:11
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.

2 participants