Add release guidance to integration guide and remove private repo links#4
Merged
Conversation
…erences - Add 'Releasing Your Engine' section to docs/integration-guide.md explaining that engines are consumed via GitHub Releases, with a sample workflow and guidance on what to include in the release tarball - Remove all references to the private github/agent-platform-engine-example repo from both README.md and docs/integration-guide.md Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates public-facing documentation to remove broken links to a private reference repository and to document how engine authors should package and distribute engines for the Copilot agent platform.
Changes:
- Removed references to the private
github/agent-platform-engine-examplerepo from the README and integration guide. - Added a “Releasing Your Engine” section describing a tag-triggered GitHub Actions flow that publishes a release artifact containing
engine.yamlplus runtime files.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Removes links to a private example engine to avoid broken references in public docs. |
| docs/integration-guide.md | Removes private repo reference and adds release/distribution guidance including a sample workflow and packaging expectations. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
- Label the release workflow YAML as a Node.js/TypeScript example and note that other runtimes should substitute their own build steps and paths. - Explicitly state that engines must bundle runtime dependencies into the build output (via a bundler) or include them in the tarball, since the compiled dist/ alone may not be self-contained. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
|
||
| This guide walks you through building a custom **engine** — a program that receives a coding task from the Copilot platform, runs an agentic loop against a repository, and streams progress back to users in real time. | ||
|
|
||
| > **📦 Reference Implementation** — See [`github/agent-platform-engine-example`](https://github.com/github/agent-platform-engine-example) for a complete working engine built with this SDK. |
Contributor
There was a problem hiding this comment.
Do we need a more verbose example that is not private that we can link to?
kinseydurhamgrace
approved these changes
Mar 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This repo's docs referenced
github/agent-platform-engine-example, which is a private repo — broken links for anyone reading the public SDK docs. Meanwhile, the example repo recently added a GitHub Actions release workflow, and the integration guide had no guidance on how engines should be distributed.Changes
Added "Releasing Your Engine" section to
docs/integration-guide.md— covers creating GitHub Releases via tag-triggered workflows, includes a sample.github/workflows/release.yml, and explains that the release tarball must includeengine.yamlalong with whatever files itsentrypointreferences (no specific directory structure prescribed).Removed all references to
github/agent-platform-engine-examplefrom bothREADME.mdanddocs/integration-guide.mdsince the repo is private and links would be broken for external readers.