Repository navigation
Added GITHUB-WORKFLOWS.md, fixed refs. - #1
Merged
Merged
Conversation
Co-authored-by: kenorb <kenorb@users.noreply.github.com>
Contributor
Reviewer's GuideAdds 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 workflowsequenceDiagram
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
Flow diagram for OpenCode workflow triggers and reusable usageflowchart 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;
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- The new
.github/GITHUB-WORKFLOWS.mdhardcodesmasteras the branch for reusable workflows; consider aligning this with the actual default branch (or documenting thatmasteris required) to avoid confusion if the default branch differs. - Several sections in
.github/GITHUB-WORKFLOWS.mdreference 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>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Member
|
/oc Fix pre-commit issues. |
Co-authored-by: kenorb <kenorb@users.noreply.github.com>
Contributor
Author
|
I have fixed the pre-commit issues and addressed the comments from the code review. Here are the changes that were made:
These changes are now ready to be automatically committed to the pull request. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

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:
.github/GITHUB-WORKFLOWS.mdwith the content filtered to keep the documentation for the currently existingcheckandopencodeworkflows..github/GITHUB-WORKFLOWS.mdfromCogni-AI-OUtoEA31337(which is this repository's owner based on the remote URL) and configured it to point to themasterbranch..github/workflows/check.ymlfile to also changeCogni-AI-OUtoEA31337where 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
opencode session | github run
Summary by Sourcery
Document and centralize GitHub workflows and matcher configuration on the EA31337/.github repository.
Enhancements:
Documentation: