LearnNewsExamplesServices
Frontmatter
id7364
titleIntegrate GitHub CLI to Streamline Contribution Workflow
stateClosed
labels
help wantedgood first issueepichacktoberfestai
assigneestobiu
createdAtOct 5, 2025, 12:23 PM
updatedAtOct 24, 2025, 11:47 AM
githubUrlhttps://github.com/neomjs/neo/issues/7364
authortobiu
commentsCount2
parentIssuenull
subIssues
7365 Document and Configure GitHub CLI Authentication
7366 Enable Agent to List GitHub Issues and PRs
7367 Create Script to Automate GitHub Issue Creation from Markdown Ticket
7368 Enhance Issue Creation Script to Sync GitHub ID back to Markdown File
7369 Update Agent Workflow to use Automated GitHub Issue Creation
7370 Enable Agent to Checkout PR Branches
7371 Enable Agent to Diff a Pull Request
7372 Enable Agent to Comment on Pull Requests
7373 Define a Clear Pull Request Review Protocol for the Agent
7376 Define Hybrid API vs. Knowledge Base Workflow for Agent
7377 Create Script to Sync New GitHub Issues to Local Markdown Files
7378 Enhance Knowledge Base to Include GitHub Comments
7381 Create a Robust GitHub CLI Setup and Verification Script
7391 Refactor createGhIssue.mjs to use fs-extra for consistency
7393 Move PR workflows to separate guide in learn/guides/ai
7414 Implement GitHub Action to Prevent Issue Reopening
7418 Refine and Integrate GitHub CLI Guide
subIssuesCompleted17
subIssuesTotal17
blockedBy[]
blocking[]
closedAtOct 24, 2025, 11:47 AM

Integrate GitHub CLI to Streamline Contribution Workflow

Closed v11.0.0 help wantedgood first issueepichacktoberfestai
tobiu
tobiu commented on Oct 5, 2025, 12:23 PM

This epic aims to deeply integrate the GitHub CLI (gh) into the development and contribution workflow. The goal is to automate the synchronization between local markdown-based tickets and GitHub issues/PRs, reduce manual effort for the project maintainer, and empower the AI agent to participate more fully in the GitHub ecosystem (e.g., reviewing PRs, creating issues).

Top-Level Items & Implementation Phases

Phase 1: Foundational CLI Integration & Authentication

  • Goal: Ensure the agent can securely authenticate with the GitHub API via gh and perform basic read-only operations.
  • Sub-Tasks:
    • ticket-create-robust-gh-setup-script.md: Create a robust script to verify gh installation, authentication, and version.
    • ticket-setup-github-cli-authentication.md: Document the process for setting up gh auth, likely using a GH_TOKEN.
    • ticket-refine-github-cli-guide.md: Refine and integrate the GitHub CLI authentication guide.
    • ticket-agent-can-list-issues-and-prs.md: Implement agent capabilities to list open issues and pull requests.

Phase 2: Automating the Ticket/Issue Workflow

  • Goal: Eliminate the manual synchronization between local markdown tickets and GitHub issues.
  • Sub-Tasks:
    • ticket-create-gh-issue-from-md-ticket.md: Create a script that uses gh to create a new GitHub issue from a local .github/ISSUE/*.md file, extracting the title and body.
    • ticket-refactor-create-gh-issue-to-use-fs-extra.md: Refactor createGhIssue.mjs to use fs-extra for consistency.
    • ticket-sync-gh-issue-id-to-md-ticket.md: The script from the previous task should automatically edit the local markdown file to insert the newly created GitHub issue URL and ID.
    • ticket-update-agent-ticket-creation-workflow.md: Update AGENTS.md to instruct the agent to use this new automated workflow instead of prompting the user to do it manually.
    • ticket-implement-gh-action-prevent-reopen.md: Implement a GitHub Action to automatically close reopened issues and create new ones.

Phase 3: Enabling Agent-led PR Review

  • Goal: Empower the agent to fetch, review, and comment on pull requests from external contributors.
  • Sub-Tasks:
    • ticket-agent-can-checkout-pr-branch.md: Implement a workflow for the agent to use gh pr checkout <PR_NUMBER> to pull down the code from a PR.
    • ticket-agent-can-diff-a-pr.md: Use gh pr diff <PR_NUMBER> to get a quick overview of changes.
    • ticket-agent-can-comment-on-pr.md: Use gh pr review --comment or gh issue comment to provide feedback on PRs.
    • ticket-define-pr-review-protocol-for-agent.md: Create a clear protocol in AGENTS.md for how the agent should conduct reviews (e.g., be constructive, focus on coding guidelines, run tests).

Phase 4: Advanced Integration & Data Enrichment

  • Goal: Enhance the agent's contextual understanding by enriching the knowledge base and refining its data access strategies.
  • Sub-Tasks:
    • ticket-define-hybrid-api-vs-kb-workflow.md: Formally document the hybrid strategy for using the GitHub API for real-time status and the local knowledge base for deep context.
    • ticket-sync-gh-issues-to-local.md: Create a script to sync new GitHub issues to local markdown files.
    • ticket-add-github-comments-to-kb.md: Enhance the knowledge base to include comments from GitHub issues and PRs.
tobiu assigned to @tobiu on Oct 5, 2025, 12:23 PM
tobiu added the help wanted label on Oct 5, 2025, 12:23 PM
tobiu added the good first issue label on Oct 5, 2025, 12:23 PM
tobiu added the epic label on Oct 5, 2025, 12:23 PM
tobiu added the hacktoberfest label on Oct 5, 2025, 12:23 PM
tobiu added the ai label on Oct 5, 2025, 12:23 PM
tobiu added sub-issue #7365 on Oct 5, 2025, 12:32 PM
tobiu
tobiu Oct 5, 2025, 12:34 PM

I think this new epic fits the hacktoberfest scope very well: https://github.com/neomjs/neo/issues/7296

These tickets require the "ai native" workflows, so you need to read these 2 first: https://github.com/neomjs/neo/blob/dev/.github/WORKING_WITH_AGENTS.md https://github.com/neomjs/neo/blob/dev/.github/AI_QUICK_START.md

Since the epic subs strongly build on and relate to each other, I also strongly recommend to join the Slack and / or Discord Channels, so that you guys can sync. Like a real project :)

https://join.slack.com/t/neomjs/shared_invite/zt-6c50ueeu-3E1~M4T9xkNnb~M_prEEOA https://discord.gg/6p8paPq

tobiu added sub-issue #7366 on Oct 5, 2025, 12:37 PM
tobiu added sub-issue #7367 on Oct 5, 2025, 12:39 PM
tobiu added sub-issue #7368 on Oct 5, 2025, 12:54 PM
tobiu added sub-issue #7369 on Oct 5, 2025, 1:00 PM
tobiu added sub-issue #7370 on Oct 5, 2025, 1:15 PM
tobiu added sub-issue #7371 on Oct 5, 2025, 1:22 PM
tobiu added sub-issue #7372 on Oct 5, 2025, 1:24 PM
tobiu added sub-issue #7373 on Oct 5, 2025, 1:33 PM
tobiu referenced in commit c99360a - "#7364 initial tickets as md files" on Oct 5, 2025, 1:37 PM
tobiu added sub-issue #7376 on Oct 5, 2025, 3:02 PM
tobiu added sub-issue #7377 on Oct 5, 2025, 3:10 PM
tobiu added sub-issue #7378 on Oct 5, 2025, 3:11 PM
tobiu referenced in commit 9d09963 - "#7364 phase 4 subs as md files" on Oct 5, 2025, 3:13 PM
tobiu referenced in commit 0531f7b - "#7364 internal ticket md file updates" on Oct 5, 2025, 5:04 PM
tobiu added sub-issue #7381 on Oct 5, 2025, 5:57 PM
tobiu referenced in commit 348d2ad - "#7364 added a new sub-ticket" on Oct 5, 2025, 5:59 PM
tobiu added sub-issue #7391 on Oct 6, 2025, 1:18 PM
tobiu referenced in commit 91af8fb - "#7364 ticket md files" on Oct 6, 2025, 1:20 PM
tobiu added sub-issue #7393 on Oct 6, 2025, 2:19 PM
tobiu cross-referenced by #7393 on Oct 6, 2025, 2:19 PM
tobiu added sub-issue #7414 on Oct 7, 2025, 5:43 PM
tobiu added sub-issue #7418 on Oct 8, 2025, 4:16 PM
tobiu cross-referenced by #7477 on Oct 14, 2025, 10:37 AM
tobiu
tobiu Oct 24, 2025, 11:47 AM

closing the epic, new items for the github-workflow mcp server will get added as new tickets / epics.

tobiu closed this issue on Oct 24, 2025, 11:47 AM