[docs] Update documentation for features from 2026-02-23#17830
Conversation
Documents the new `private: true` frontmatter field that prevents workflows from being installed into other repositories via `gh aw add`. - Adds Private Workflows section to frontmatter reference - Adds note about private workflows to the packaging/imports guide Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
✅ Pull request created: #17830 |
There was a problem hiding this comment.
Pull request overview
This PR updates documentation to cover the new private: true frontmatter field introduced in PR #17801. The field allows workflow authors to prevent their workflows from being installed into other repositories via gh aw add.
Changes:
- Added comprehensive documentation for the
private:frontmatter field in the reference guide - Added a note in the packaging/imports guide warning users about the restriction
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/src/content/docs/reference/frontmatter.md | Adds new "Private Workflows (private:)" section documenting the field's behavior, error messages, use cases, and scope limitations |
| docs/src/content/docs/guides/packaging-imports.md | Adds note in "Adding Workflows" section warning that workflows marked private: true cannot be added from external repositories |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### Private Workflows (`private:`) | ||
|
|
||
| Mark a workflow as private to prevent it from being installed into other repositories via `gh aw add`. |
There was a problem hiding this comment.
For consistency with other boolean fields like strict: (line 354), consider mentioning the default value. The field defaults to false, meaning workflows are not private unless explicitly marked. This could be added to line 59, for example: "Mark a workflow as private to prevent it from being installed into other repositories via gh aw add. Defaults to false."
| Mark a workflow as private to prevent it from being installed into other repositories via `gh aw add`. | |
| Mark a workflow as private to prevent it from being installed into other repositories via `gh aw add`. Defaults to `false`. |
Documentation Updates - 2026-02-23
This PR updates the documentation based on features merged in the last 24 hours.
Features Documented
private: truefrontmatter field that blocksgh aw addfrom installing workflows into other repositories (from Addprivatefrontmatter field to blockaddcommand #17801)Changes Made
docs/src/content/docs/reference/frontmatter.mdto add a new Private Workflows (private:) section documenting the new field, its behavior, and a clarifying note that it only restrictsgh aw add(not repository visibility)docs/src/content/docs/guides/packaging-imports.mdto add a note in the "Adding Workflows" section, warning users that workflows markedprivate: truecannot be added from external repositoriesMerged PRs Referenced
privatefrontmatter field to blockaddcommand #17801 — Addprivatefrontmatter field to blockaddcommandNotes
PR #17803 (CI trigger token) already included its own documentation updates to
auth.mdx,faq.md, andsafe-outputs.md. PR #17801 regeneratedfrontmatter-full.mdbut left the main human-readablefrontmatter.mdwithout the newprivate:field — this PR fills that gap.