Skip to content

[docs] Update documentation for features from 2026-03-08#20020

Merged
pelikhan merged 1 commit intomainfrom
docs/update-docs-2026-03-08-c21316693eab79ee
Mar 8, 2026
Merged

[docs] Update documentation for features from 2026-03-08#20020
pelikhan merged 1 commit intomainfrom
docs/update-docs-2026-03-08-c21316693eab79ee

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Mar 8, 2026

Documentation Updates - 2026-03-08

This PR updates the documentation based on features merged in the last 24 hours.

Features Documented

Changes Made

  • Added ### Resources (\resources:`)section todocs/src/content/docs/reference/frontmatter.md, placed after private:since both fields relate togh aw add` behavior
  • Updated docs/src/content/docs/guides/packaging-imports.md to describe what gh aw add automatically fetches (dispatch-workflow deps and resources: files)
  • Added a callout to the dispatch-workflow: section in docs/src/content/docs/reference/safe-outputs.md noting that listed workflows are auto-fetched during gh aw add

Merged PRs Referenced

Notes

Other merged PRs from this period were already documented as part of their own PRs:

Generated by Daily Documentation Updater ·

  • expires on Mar 9, 2026, 4:24 AM UTC

Document the new `resources:` frontmatter field added in PR #19965, which
declares additional workflow/action files fetched when running `gh aw add`.
Also note that dispatch-workflow dependencies are automatically fetched.

- Add `resources:` section to frontmatter.md (after `private:`)
- Update packaging-imports.md to describe automatic dependency fetching
- Add note to dispatch-workflow section in safe-outputs.md

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Mar 8, 2026
@pelikhan pelikhan marked this pull request as ready for review March 8, 2026 04:50
Copilot AI review requested due to automatic review settings March 8, 2026 04:50
@pelikhan pelikhan merged commit 35d0c88 into main Mar 8, 2026
@pelikhan pelikhan deleted the docs/update-docs-2026-03-08-c21316693eab79ee branch March 8, 2026 04:50
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the documentation to cover new gh aw add behavior introduced in #19965: fetching dispatch-workflow dependencies and additional files declared via a new resources: frontmatter field.

Changes:

  • Documented the new resources: frontmatter field in the frontmatter reference.
  • Updated the packaging/imports guide to explain what gh aw add auto-fetches during installation.
  • Added a note to the dispatch-workflow: safe output reference about dependency fetching during gh aw add.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
docs/src/content/docs/reference/frontmatter.md Adds reference docs for resources: and how it relates to gh aw add.
docs/src/content/docs/guides/packaging-imports.md Clarifies that gh aw add fetches dispatch-workflow deps and resources: files.
docs/src/content/docs/reference/safe-outputs.md Adds a callout note about dispatch-workflow auto-fetch behavior during installs.
Comments suppressed due to low confidence (1)

docs/src/content/docs/reference/frontmatter.md:91

  • “Placed alongside the main workflow” is ambiguous/inaccurate for nested resource paths: resources are written under the target workflows directory preserving their relative path (e.g. shared/helper-action.yml becomes .github/workflows/shared/helper-action.yml), not necessarily in the same folder as the main workflow file. Consider clarifying the destination path behavior.
When a user runs `gh aw add` to install this workflow, each listed file is also downloaded and placed alongside the main workflow in the target repository. This ensures companion workflows and custom actions the main workflow depends on are available after installation.

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

Comment on lines +80 to +81
Declares additional workflow or action files to fetch alongside this workflow when running `gh aw add`. Use this field when the workflow depends on companion workflows or custom actions stored in the same directory.

Copy link

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The text implies resources: is only for companion files "stored in the same directory", but the implementation resolves each entry relative to the workflow’s directory and allows subpaths (e.g. shared/helper-action.yml) as well as repo-root paths (leading /). Consider rephrasing to avoid suggesting resources must be co-located in the same folder.

This issue also appears on line 91 of the same file.

Copilot uses AI. Check for mistakes.
Triggers other workflows in the same repository using GitHub's `workflow_dispatch` event. This enables orchestration patterns, such as orchestrator workflows that coordinate multiple worker workflows.

> [!NOTE]
> When installing a workflow with `gh aw add`, workflows listed in `dispatch-workflow` are automatically fetched and added to the target repository alongside the main workflow.
Copy link

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This note reads as if gh aw add always fetches dispatch-workflow dependencies, but the current behavior only fetches them when adding a workflow from a remote repository; local-path adds don’t download additional workflows. Consider wording like “When adding a workflow from a remote repo with gh aw add…” to avoid misleading users.

Suggested change
> When installing a workflow with `gh aw add`, workflows listed in `dispatch-workflow` are automatically fetched and added to the target repository alongside the main workflow.
> When adding a workflow from a remote repo with `gh aw add`, workflows listed in `dispatch-workflow` are automatically fetched and added to the target repository alongside the main workflow.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants