Skip to content

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Feb 5, 2026

Documentation Sync - Past 7 Days

This PR synchronizes documentation with recent code changes by adding missing documentation for the --skip-pull CLI flag.

Changes Made

  • Updated docs/usage.md: Added --skip-pull flag to Command-Line Options section
  • Added new section: "Using Pre-Downloaded Images" with comprehensive examples and use cases

Background

During the documentation review, I identified that the --skip-pull flag (defined in src/cli.ts:605-608) was implemented in code but not documented anywhere in the user-facing documentation.

What the Flag Does

The --skip-pull flag allows users to use locally pre-downloaded Docker images without pulling from the registry. This is valuable for:

  • Offline/air-gapped environments: Where network access to container registries is unavailable
  • CI pipeline optimization: Leveraging Docker layer caching to speed up workflows
  • Version pinning: Using specific pre-downloaded image versions for reproducibility

Documentation Added

  1. CLI Options Table (line 40): Added the flag with brief description
  2. New Section "Using Pre-Downloaded Images": Comprehensive guide including:
    • Basic usage example
    • Offline/air-gapped environment workflow with docker save/load
    • CI pipeline caching example with GitHub Actions
    • Version-specific image usage
    • Important compatibility notes (not compatible with --build-local)
    • Error handling guidance

Code Changes Referenced

  • Commit 6e8527e: feat: add AWF agent skill for Claude Code agents (feat: add AWF agent skill for Claude Code agents #515)
    • This commit initialized the repository with GitHub Agentic Workflows infrastructure
    • The --skip-pull flag exists in the codebase but was not documented

Verification

  • ✅ Flag matches code implementation in src/cli.ts
  • ✅ Validation logic documented correctly (incompatible with --build-local)
  • ✅ Error message in docs matches code behavior
  • ✅ Examples use correct registry paths and syntax
  • ✅ Consistent with existing documentation style

Additional Notes

Since this is a shallow repository clone with only one visible commit from the past 7 days, I performed a comprehensive code-vs-documentation review. This was the only significant documentation gap identified - all other CLI flags and features are properly documented.

AI generated by Documentation Maintainer

@github-actions github-actions bot added ai-generated documentation Improvements or additions to documentation labels Feb 5, 2026
@github-actions
Copy link
Contributor Author

github-actions bot commented Feb 5, 2026

Smoke Test Results

Last 2 Merged PRs:

Tests:

  • ✅ GitHub MCP (list PRs)
  • ✅ Playwright (GitHub page title verified)
  • ✅ File write (/tmp/gh-aw/agent/smoke-test-copilot-21711413475.txt)
  • ✅ Bash tool (file read verified)

Overall: PASS

cc @github-actions[bot]

AI generated by Smoke Copilot

@Mossaka Mossaka merged commit a4c7b7c into main Feb 5, 2026
@Mossaka Mossaka deleted the doc-maintainer/skip-pull-documentation-b3f90411f96da9cd branch February 5, 2026 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-generated documentation Improvements or additions to documentation smoke-copilot

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant