Skip to content

Added GITHUB-WORKFLOWS.md, fixed refs. - #1

Merged
kenorb merged 3 commits into
masterfrom
opencode/dispatch-050958-20260415224250
Apr 18, 2026
Merged

kenorb merged 3 commits into
masterfrom
opencode/dispatch-050958-20260415224250

Conversation

@opencode-agent

@opencode-agent opencode-agent Bot commented Apr 15, 2026 •

Copy link
Copy Markdown
Contributor

I have successfully fetched the requested markdown file and added it to the repository as .github/GITHUB-WORKFLOWS.md.

Here is a summary of the changes I made:

  1. Created .github/GITHUB-WORKFLOWS.md with the content filtered to keep the documentation for the currently existing check and opencode workflows.
  2. Updated all references in .github/GITHUB-WORKFLOWS.md from Cogni-AI-OU to EA31337 (which is this repository's owner based on the remote URL) and configured it to point to the master branch.
  3. Updated the existing .github/workflows/check.yml file to also change Cogni-AI-OU to EA31337 where it downloads matcher files from the repository so that the whole repository uses the EA repo as its single source of truth.

Let me know if you would like me to commit these changes!

Triggered by workflow_dispatch

New%20session%20-%202026-04-15T22%3A42%3A49.079Z
opencode session  |  github run

Summary by Sourcery

Document and centralize GitHub workflows and matcher configuration on the EA31337/.github repository.

Enhancements:

  • Update the check workflow to use matcher files from the EA31337/.github repository as the single source of truth instead of Cogni-AI-OU.

Documentation:

  • Add GITHUB-WORKFLOWS.md documenting the Check and OpenCode reusable workflows, their triggers, usage examples, and security considerations.
  • Describe available GitHub Actions problem matchers and how to configure or override them when consuming the reusable workflows.

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

sourcery-ai Bot commented Apr 15, 2026 •

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Adds central GitHub workflow documentation for this repo and updates workflow references to use the EA31337/.github repository and master branch as the single source of truth for reusable workflows and problem matcher files.

Sequence diagram for matcher resolution in updated check workflow

sequenceDiagram
  participant Consumer_repo
  participant Caller_workflow
  participant Reusable_check as EA31337_check.yml
  participant GitHub as GitHub_Actions
  participant Matchers_repo as EA31337_.github_repo

  Consumer_repo->>GitHub: trigger Caller_workflow
  GitHub->>Caller_workflow: run workflow
  Caller_workflow->>Reusable_check: invoke via workflow_call

  alt actionlint matcher path not provided
    Reusable_check->>GitHub: actions/checkout@v6
    GitHub->>Matchers_repo: fetch EA31337/.github
    Matchers_repo-->>GitHub: .github/actionlint-matcher.json
    GitHub-->>Reusable_check: checkout .github-matchers directory
    Reusable_check->>GitHub: register actionlint problem matcher
  else custom actionlint matcher path provided
    Reusable_check->>GitHub: register matcher from inputs.actionlint-matcher-path
  end

  alt pre-commit matcher path not provided
    Reusable_check->>GitHub: actions/checkout@v6
    GitHub->>Matchers_repo: fetch EA31337/.github
    Matchers_repo-->>GitHub: .github/pre-commit-matcher.json
    GitHub-->>Reusable_check: checkout .github-matchers directory
    Reusable_check->>GitHub: register pre-commit problem matcher
  else custom pre-commit matcher path provided
    Reusable_check->>GitHub: register matcher from inputs.pre-commit-matcher-path
  end
Loading

Flow diagram for OpenCode workflow triggers and reusable usage

flowchart TD
  A_start["GitHub events"] --> B_issue_comment[issue_comment created or edited]
  A_start --> C_pr_review_comment[pull_request_review_comment created or edited]
  A_start --> D_issues[issues opened]
  A_start --> E_pr_review[pull_request_review submitted]
  A_start --> F_workflow_dispatch[workflow_dispatch]
  A_start --> G_workflow_call[workflow_call from another repo]

  subgraph OpenCode_Workflow["OpenCode workflow in EA31337/.github"]
    H_opencode_job[opencode job]
  end

  B_issue_comment --> H_opencode_job
  C_pr_review_comment --> H_opencode_job
  D_issues --> H_opencode_job
  E_pr_review --> H_opencode_job
  F_workflow_dispatch --> H_opencode_job
  G_workflow_call --> H_opencode_job

  subgraph Consumer_repo["Consumer repository"]
    I_opencode_caller[Reusable OpenCode workflow caller]
  end

  I_opencode_caller -->|uses workflow_call| H_opencode_job

  classDef evt fill:#e6f7ff,stroke:#339;
  classDef job fill:#f6ffed,stroke:#393;
  classDef repo fill:#f5f5ff,stroke:#555;

  class A_start,B_issue_comment,C_pr_review_comment,D_issues,E_pr_review,F_workflow_dispatch,G_workflow_call evt;
  class H_opencode_job job;
  class OpenCode_Workflow,Consumer_repo repo;
Loading

File-Level Changes

Change Details Files
Update the check workflow to source problem matcher defaults from EA31337/.github instead of Cogni-AI-OU/.github.
  • Adjusted help text for actionlint and pre-commit matcher input descriptions to reference the EA31337/.github repository.
  • Updated the repository owner in the checkout steps that fetch default matcher JSON files so they pull from EA31337/.github.
.github/workflows/check.yml
Introduce GitHub workflow documentation tailored to this repository and its existing workflows.
  • Added a repository-scoped GITHUB-WORKFLOWS.md describing the check and opencode workflows, including how to consume them via workflow_call and workflow_dispatch.
  • Documented the available problem matchers, their usage, and how they are provided by this repo when check.yml is reused.
  • Described security considerations, required protections, and tooling available when using the OpenCode workflow in this repo, with references updated to EA31337 and the master branch.
.github/GITHUB-WORKFLOWS.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 found 1 issue, and left some high level feedback:

  • The new .github/GITHUB-WORKFLOWS.md hardcodes master as the branch for reusable workflows; consider aligning this with the actual default branch (or documenting that master is required) to avoid confusion if the default branch differs.
  • Several sections in .github/GITHUB-WORKFLOWS.md reference supporting files like .devcontainer/requirements.txt, .lycheeignore, and .markdown-link-check.json; double-check these paths exist in this repo or adjust the examples to match the actual project layout.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The new `.github/GITHUB-WORKFLOWS.md` hardcodes `master` as the branch for reusable workflows; consider aligning this with the actual default branch (or documenting that `master` is required) to avoid confusion if the default branch differs.
- Several sections in `.github/GITHUB-WORKFLOWS.md` reference supporting files like `.devcontainer/requirements.txt`, `.lycheeignore`, and `.markdown-link-check.json`; double-check these paths exist in this repo or adjust the examples to match the actual project layout.

## Individual Comments

### Comment 1
<location path=".github/GITHUB-WORKFLOWS.md" line_range="9-10" />
<code_context>
+
+### Check Workflow
+
+The `check.yml` workflow runs on pull requests, pushes, and weekly schedule to
+ensure code quality and correctness.
+
</code_context>
<issue_to_address>
**suggestion (typo):** Consider adding an article before "weekly schedule" for grammatical correctness.

Consider phrasing this as "runs on pull requests, pushes, and a weekly schedule" for more natural grammar.

```suggestion
The `check.yml` workflow runs on pull requests, pushes, and a weekly schedule to
ensure code quality and correctness.
```
</issue_to_address>

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.

Comment thread .github/GITHUB-WORKFLOWS.md Outdated
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@kenorb

kenorb commented Apr 16, 2026

Copy link
Copy Markdown
Member

/oc Fix pre-commit issues.

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

Copy link
Copy Markdown
Contributor Author

I have fixed the pre-commit issues and addressed the comments from the code review.

Here are the changes that were made:

  1. Addressed Code Review Comments:
    • Updated the Link Checker documentation in .github/GITHUB-WORKFLOWS.md to remove references to non-existent configurations (.devcontainer/requirements.txt, .lycheeignore, .markdown-link-check.json) and provided a more accurate command for local lychee testing.
    • Added a clarifying note inside the sections covering reusable workflows (Check Workflow and OpenCode Workflow) explaining that the master branch is required as it is the default branch for the EA31337/.github repository.
  2. Fixed pre-commit workflow failures:
    • The check.yml workflow was failing on pre-commit because .pre-commit-config.yaml did not exist in this repository. I have created a minimal .pre-commit-config.yaml file with basic standard hooks (trailing-whitespace, end-of-file-fixer, check-yaml, check-json) to allow the GitHub Action to run correctly.
    • Ran pre-commit run --all-files, which corrected a missing newline at the end of .github/GITHUB-WORKFLOWS.md and some trailing whitespace in profile/README.md.

These changes are now ready to be automatically committed to the pull request.

New%20session%20-%202026-04-16T03%3A17%3A36.753Z
opencode session  |  github run

@kenorb
kenorb merged commit fca1ef7 into master Apr 18, 2026
8 checks passed
@kenorb
kenorb deleted the opencode/dispatch-050958-20260415224250 branch April 18, 2026 15:49
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