Skip to content

Add GitHub Action how-to guide to docs site #474

@sergeyklay

Description

@sergeyklay

The official GitHub Action (#280) lets users run Sortie from any GitHub repo with no binary install and no server. The docs site needs a how-to page that takes a reader from an empty repo to a working scheduled run.

Scope: a concrete end-to-end example workflow file (.github/workflows/sortie.yml) with a cron trigger and workflow_dispatch, the full input table (workflow, version, timeout, args) with defaults and valid values, guidance on configuring the required secrets (GITHUB_TOKEN, provider API keys) in the repo settings, common patterns (scheduled vs on-push vs on-label triggers), notes on how the runner must have the chosen agent CLI available (npx, gh copilot, etc.), and a troubleshooting section covering typical failures (missing secrets, agent not found, timeout behavior). Link to the GitHub Issues tracker adapter reference since that is the natural pairing.

Depends on #280 (Action implementation and Marketplace listing).

Verify: a new how-to/github-action.md page exists on docs.sortie-ai.com, includes a copy-paste workflow example that works against a fresh public repo, and is linked from the how-to index and the GitHub Issues adapter reference.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:cliCLI flags, subcommands, version outputarea:docs-sitedocs.sortie-ai.com content and infrastructure

    Type

    Projects

    Status

    Todo

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions