Skip to content

docs: Organization Practices#28688

Draft
Copilot wants to merge 12 commits intomainfrom
copilot/sub-pr-28676
Draft

docs: Organization Practices#28688
Copilot wants to merge 12 commits intomainfrom
copilot/sub-pr-28676

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 27, 2026

Adds Organization Practices pages under Guides in the sidebar.

Changes Made

  • Safe Rollout: New page describing the rollout ladder from report-only to production writes, including staged mode and shadow evaluation techniques.
  • Sharing Workflows: New page covering the 7 layers of enterprise workflow sharing:
    1. Copy/install whole workflows via gh aw add with version refs and source: tracking
    2. Reusable workflow components via imports: for tools, MCP servers, steps, and prompt snippets
    3. Parameterized templates via uses/with for shared imports with runtime inputs
    4. Versioning and update flow — semantic versions, branch refs, SHA pins, and gh aw update with 3-way merge
    5. Private/internal sharing controls via private: true and org-internal repository visibility
    6. Import caching and lock behavior — .lock.yml and .github/aw/imports/ SHA cache for reproducibility
    7. Cross-repository execution model via target-repo/allowed-repos for runtime cross-repo reads and writes
  • Enterprise pattern: Documents the recommended model of one central agentic-workflows repository with versioned templates and shared components, consumed via gh aw add and imports:.
  • Future-change banner: Added a note banner on the Sharing Workflows page and the Reusing Workflows guide indicating these patterns may change in future releases.
  • Sidebar: Organization Practices is nested as a sub-group under Guides (not a standalone top-level section).
  • Glossary: No entries added for Organization Practices topics.

Copilot AI mentioned this pull request Apr 27, 2026
@mnkiefer mnkiefer changed the title [WIP] [WIP] Docs: Add Organization practices & CorrectionOps [WIP] docs: Add CorrectionOps Apr 27, 2026
Copilot AI changed the title [WIP] docs: Add CorrectionOps docs: Scope PR to Organization Practices only; split out CorrectionOps Apr 27, 2026
Copilot AI requested a review from mnkiefer April 27, 2026 11:00
@mnkiefer mnkiefer changed the title docs: Scope PR to Organization Practices only; split out CorrectionOps [WIP] docs: Organization Practices Apr 27, 2026
@mnkiefer mnkiefer changed the base branch from add-shadow-ops to main April 27, 2026 11:03
@mnkiefer
Copy link
Copy Markdown
Collaborator

@copilot No glossary entries for this. Also put "Organization Practices" section under "Guides" and not "Design patterns".

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 27, 2026

@copilot No glossary entries for this. Also put "Organization Practices" section under "Guides" and not "Design patterns".

Done in 210ab9f:

  • Removed the Organization Practices, Safe Rollout, and Shadow Evaluation glossary entries.
  • Moved Organization Practices as a nested sub-group inside Guides in the sidebar (no longer a standalone top-level section).

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 27, 2026

Smoke CI completed successfully!

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 27, 2026

Smoke CI completed successfully!

@github-actions
Copy link
Copy Markdown
Contributor

✅ smoke-ci: safeoutputs CLI comment + comment-memory run (24995461080)

Generated by Smoke CI for issue #28688 ·

@mnkiefer
Copy link
Copy Markdown
Collaborator

@copilot Update text: For sharing GitHub Agentic Workflows, they should support a few layers:

  1. Copy/install whole workflows: A repo should be able to pull in a workflow from another repo:
    gh aw add acme-org/agentic-workflows/ci-doctor@v1.2.0
    GitHub AW already supports this via gh aw add, gh aw add-wizard, version refs, and a source: field for later updates.
  2. Reusable workflow components: Shared pieces should be importable:
imports:
  - acme-org/shared-workflows/shared/security-setup.md@v2.1.0
  - acme-org/shared-workflows/shared/mcp/tavily.md@v1.0.0

AW supports imports: for shared tools, MCP servers, steps, jobs, and prompt snippets.
3. Parameterized templates: Shared workflows should take inputs:

imports:
  - uses: acme-org/shared-workflows/shared/reviewer.md@v1
    with:
      languages: ["go", "typescript"]
      severity: "high"

AW supports uses / with for parameterized imports.
4. Versioning and update flow: Enterprise sharing needs:

  • Semantic versions for stable workflows
  • Branch refs for dev
  • SHA pins for strict reproducibility
  • gh aw update to pull upstream changes
  • 3-way merge to preserve local edits
    AW documents this model directly.
  1. Private/internal sharing controls
    They should support:
  • Org-internal workflow catalogs
  • Private workflows that cannot be imported elsewhere
  • Access checks before install
  • Trusted-source warnings
    AW has access-based imports and private: true to block adding workflows to other repos.
  1. Import caching / lock behavior: Shared imports should be cached and compiled into .lock.yml so runs are reproducible. AW caches remote imports under .github/aw/imports/ by commit SHA.
  2. Cross-repo execution model: Separate from sharing definitions, workflows should support operating across repos: read other repos, check out code, and create safe outputs in target repos with explicit auth and allowlists. AW has cross-repo checkout, reading, and safe outputs via target-repo / allowed-repos.
    Currently, the guide should describe that the ideal enterprise pattern is one central "agentic-workflows" repo with versioned workflow templates and shared components, then consuming repos use gh aw add for full workflows and imports: for common modules.Note, that this may change in the future so add a banner a on other pages (this is new).

@mnkiefer mnkiefer changed the title [WIP] docs: Organization Practices docs: Organization Practices Apr 27, 2026
@mnkiefer mnkiefer changed the title docs: Organization Practices docs: Organization practices Apr 27, 2026
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 27, 2026

@copilot Update text: For sharing GitHub Agentic Workflows, they should support a few layers:

  1. Copy/install whole workflows: A repo should be able to pull in a workflow from another repo:
    `gh aw a...

Done in 0e3f274. The sharing-workflows.md page has been rewritten to cover all 7 layers:

  1. Copy/install whole workflowsgh aw add acme-org/agentic-workflows/ci-doctor@v1.2.0 with source: tracking
  2. Reusable workflow componentsimports: for shared tools, MCP servers, and prompt snippets
  3. Parameterized templatesuses/with for parameterized shared imports
  4. Versioning and update flow — semantic versions, branch refs, SHA pins, and gh aw update with 3-way merge
  5. Private/internal sharing controlsprivate: true, repo visibility, and org-internal catalogs
  6. Import caching and lock behavior.lock.yml + .github/aw/imports/ SHA cache
  7. Cross-repository execution modeltarget-repo/allowed-repos for runtime cross-repo reads and writes

A "Recommended Enterprise Pattern" section describes the central agentic-workflows repo model. The "may change in the future" banner has been added to both sharing-workflows.md and packaging-imports.mdx.

Copilot AI changed the title docs: Organization practices docs: Organization Practices Apr 27, 2026
@github-actions github-actions Bot mentioned this pull request Apr 28, 2026
Copilot AI added a commit that referenced this pull request Apr 28, 2026
…e-computed schema diff step

- Add max-turns: 60 to engine config (was unconstrained, causing 138-turn runs)
- Add checkout: fetch-depth: 1, current: true for clean repo state
- Add pre-agent-steps with deterministic bash script that pre-computes:
  - All schema top-level fields (jq)
  - All yaml-tagged struct fields from pkg/parser and pkg/workflow (grep)
  - All frontmatter keys used in .github/workflows/*.md
  - Schema field types
  - Field gap diffs (in_schema_not_parser, in_parser_not_schema, etc.)
  - Writes result to /tmp/gh-aw/agent/schema-diff.json
- Update Implementation Steps to instruct agent to start from pre-computed data
- Update Efficiency guidelines to reinforce use of pre-computed data

Fixes: #28688 (deep-report right-size schema consistency checker)"

Agent-Logs-Url: https://github.com/github/gh-aw/sessions/db6101c0-1700-4f5b-a09d-e116df370705

Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
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