Skip to content

Moved and updated workflow docs. - #5

Merged
kenorb merged 2 commits into
masterfrom
opencode/dispatch-66f114-20260418215726
Apr 18, 2026
Merged

kenorb merged 2 commits into
masterfrom
opencode/dispatch-66f114-20260418215726

Conversation

@opencode-agent

Copy link
Copy Markdown
Contributor

I have successfully moved the documentation from .github/GITHUB-WORKFLOWS.md to .github/workflows/README.md.

While moving the documentation, I've also read the existing workflow files and documented all of them. The following newly discovered workflows have now been added to the README:

  • cogni-ai-agent.yml (Cogni AI Agent Workflow)
  • copilot-setup-steps.yml (Copilot Setup Steps Workflow)
  • devcontainer-ci.yml (Development Containers CI Workflow)

The old GITHUB-WORKFLOWS.md file has been removed using git rm. You can now commit and push these changes!

Triggered by workflow_dispatch

New%20session%20-%202026-04-18T21%3A57%3A25.203Z
opencode session  |  github run

Co-authored-by: kenorb <kenorb@users.noreply.github.com>
@sourcery-ai

sourcery-ai Bot commented Apr 18, 2026

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Documentation for GitHub workflows was relocated from .github/GITHUB-WORKFLOWS.md to .github/workflows/README.md, and expanded to include newly documented workflows for Cogni AI Agent, Copilot setup, and Devcontainer CI, including reusable workflow usage instructions.

File-Level Changes

Change Details Files
Relocated and expanded GitHub workflow documentation, including new sections for Cogni AI Agent, Copilot setup, and Devcontainer CI workflows.
  • Moved the workflows documentation file from .github/GITHUB-WORKFLOWS.md to .github/workflows/README.md and removed the old file via git rm.
  • Documented the cogni-ai-agent.yml workflow, including triggers, action used, model configurability, and required OPENCODE_API_KEY secret.
  • Documented the copilot-setup-steps.yml workflow, describing Python dependency installation, caching behavior, and PATH updates for local binaries.
  • Documented the devcontainer-ci.yml workflow, outlining build/test steps for development containers, GHCR login, cache usage, and validation behavior.
  • Added a subsection describing how to consume the Devcontainer CI workflow as a reusable workflow via workflow_call with inputs for required_commands and required_python_packages.
  • Performed a minor formatting-only change to the closing note about preferring native tools over shell equivalents.
.github/GITHUB-WORKFLOWS.md
.github/workflows/README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@kenorb

kenorb commented Apr 18, 2026

Copy link
Copy Markdown
Member

/co Add .github/workflows/AGENTS.md with list and key information about the workflows for agents.

Co-authored-by: kenorb <kenorb@users.noreply.github.com>
@opencode-agent

Copy link
Copy Markdown
Contributor Author

The .github/workflows/AGENTS.md file is now complete, documenting the agent workflows and passing all validation checks. I've verified the workflows with actionlint and the markdown file with markdownlint, both through pre-commit. I'm now ready to finish.

I have added the .github/workflows/AGENTS.md file, which provides a concise yet comprehensive overview of the GitHub Actions workflows available for autonomous agents in this repository.

Key Changes:

  • Created .github/workflows/AGENTS.md: This new file serves as a single source of truth for agent-related workflow operations, documenting roles, triggers, shell permissions, and environment setup.
  • Workflow Coverage: Included detailed information on Cogni AI Agent, OpenCode, Copilot Setup Steps, Check Workflow, and Development Containers CI.
  • Agent Guidelines: Added explicit directives for agents, such as prioritizing native tools over shell equivalents and using specific gh commands for CI diagnosis.
  • Validation: Verified the integrity of all workflow files using actionlint and ensured the new documentation adheres to formatting standards using markdownlint.

This documentation will help agents (and human developers) better understand and utilize the automated processes configured in this repository.

New%20session%20-%202026-04-18T22%3A02%3A33.407Z
opencode session  |  github run

@kenorb
kenorb merged commit 0b3d1c5 into master Apr 18, 2026
7 checks passed
@kenorb
kenorb deleted the opencode/dispatch-66f114-20260418215726 branch April 18, 2026 22:05
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.

1 participant