Skip to content

[WIP] Document SideRepoOps development process - #5904

Merged
pelikhan merged 2 commits into
mainfrom
copilot/document-side-repo-ops-process
Dec 8, 2025
Merged

[WIP] Document SideRepoOps development process#5904
pelikhan merged 2 commits into
mainfrom
copilot/document-side-repo-ops-process

Conversation

Copilot AI commented Dec 8, 2025

Copy link
Copy Markdown
Contributor

Documentation Plan: SideRepoOps Development Process

  • Create docs/src/content/docs/guides/siderepoops.md documenting the SideRepoOps pattern
    • Overview and when to use SideRepoOps
    • How it differs from MultiRepoOps
    • Setup requirements (separate repo, PAT configuration)
    • Workflow configuration for targeting other repos
    • GitHub token setup for private repo access
    • Manual issue transfer workflow
    • Example workflows
    • Best practices
  • Update sidebar configuration in docs/astro.config.mjs to add SideRepoOps to Design Patterns
  • Verify documentation builds successfully (builds successfully with all 61 pages)
  • Final review and cleanup

Summary

Successfully documented the SideRepoOps development pattern, which enables running agentic workflows from a separate repository that targets a main codebase. The documentation includes:

✅ Complete guide with setup instructions, workflow examples, and best practices
✅ Clear distinction from MultiRepoOps pattern
✅ PAT configuration for private repository access
✅ Issue management and transfer workflows
✅ Troubleshooting section for common problems
✅ Advanced topics including GitHub Apps and multi-target scenarios
✅ Successfully builds with Astro Starlight (61 pages)
✅ Added to Design Patterns section in sidebar navigation

Original prompt

Document the "SideRepoOps" development process:

One can use a separate repo to run agentic workflow in order to minimize the noise of generated AI items or keep the workflows private .

  • a (public/private) repository contains the agentic workflows which run in the actions of that workflow (this repo can be empty)
  • the PAT github token is needed to access the main repo if private
  • the agentic workflow need to mention that they need to target another repositories
  • generated issues can be manually transferred as needed.

Custom agent used: technical-doc-writer
AI technical documentation writer for GitHub Actions library using Astro Starlight and GitHub Docs voice


💡 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.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
@pelikhan
pelikhan marked this pull request as ready for review December 8, 2025 21:03
@pelikhan
pelikhan merged commit ddd1c73 into main Dec 8, 2025
5 checks passed
@pelikhan
pelikhan deleted the copilot/document-side-repo-ops-process branch December 8, 2025 21:03
Copilot AI requested a review from pelikhan December 8, 2025 21:04
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