GitHub Automation Operations

Feature Overview

• Repository management and file operations
• Pull Request (PR) creation and review
• Issue management and tracking
• Branch management and merging
• CI/CD workflow automation
• Code search and analysis

Usage Scenarios

• "Create a new GitHub repository"
• "Commit code and create a Pull Request"
• "Batch process GitHub Issues"
• "Automate code review processes"
• "Search for specific code in code repositories"
• "Manage GitHub Actions workflows"

Core Function Modules

1. Repository Management

• Create Repository: Create new public or private repositories
• Fork Repository: Fork other repositories to your account
• Search Repository: Search repositories by keywords
• File Operations: Read, create, and update files
• Batch Commit: Commit multiple files at once

2. Pull Request Management

• Create PR: Create a Pull Request from a branch
• Review PR: Add comments and review feedback
• Merge PR: Merge the Pull Request
• View Changes: Get file changes in the PR
• Status Check: View CI/CD status

3. Issue Management

• Create Issue: Create new issues or tasks
• Update Issue: Modify status, labels, and assignees
• Search Issue: Filter Issues by conditions
• Add Comment: Add discussions in Issues
• Batch Operations: Batch process multiple Issues

4. Branch Management

• Create Branch: Create a new branch from the specified branch
• View Commits: List commit history of a branch
• Branch Protection: Configure branch protection rules
• Merge Strategy: Select merge methods (merge, squash, rebase)

5. Code Search

• Search Code: Search code snippets in repositories
• Search Issue: Search Issues and PRs
• Search User: Find GitHub users
• Advanced Query: Use GitHub search syntax

Workflows

Standard Development Workflow

1. Create Branch: Create a feature branch from main
2. Develop Code: Write and test code
3. Commit Changes: Commit files to the branch
4. Create PR: Create a Pull Request
5. Code Review: Team conducts code review
6. Merge Code: Merge into the main branch

Automated Release Workflow

1. Listen to Events: Listen for push or tag events
2. Run Tests: Execute automated tests
3. Build Project: Compile and package the project
4. Create Release: Publish a new version
5. Deploy Application: Automatically deploy to production environment

Issue Management Workflow

1. Create Issue: Report issues or requirements
2. Assign Tasks: Specify assignees
3. Add Labels: Classify and set priorities
4. Track Progress: Update status
5. Close Issue: Close after completion

Best Practices

Commit Guidelines

• Use clear commit messages
• Follow the Conventional Commits specification
• Solve one issue per commit
• Include necessary tests and documentation

PR Guidelines

• Provide detailed PR descriptions
• Link related Issues
• Ensure CI checks pass
• Respond to review feedback promptly
• Keep PR size moderate

Branch Strategy

• Use Git Flow or GitHub Flow
• Protect the main branch
• Regularly sync with upstream branches
• Delete merged branches in a timely manner

Security Practices

• Do not commit sensitive information
• Use GitHub Secrets to manage keys
• Enable two-factor authentication
• Regularly review permission settings
• Follow open source project contribution guidelines

Common Code Examples

1. Create Repository and Commit Files

// 创建仓库
const repo = await createRepository({
  name: "my-project",
  description: "项目描述",
  private: false,
  autoInit: true
});

// 批量提交文件
await pushFiles({
  owner: "username",
  repo: "my-project",
  branch: "main",
  files: [
    {
      path: "README.md",
      content: "# My Project\n\n项目说明"
    },
    {
      path: "src/index.js",
      content: "console.log('Hello World');"
    }
  ],
  message: "Initial commit"
});

2. Create Branch and Pull Request

// 创建新分支
await createBranch({
  owner: "username",
  repo: "my-project",
  branch: "feature/new-feature",
  from_branch: "main"
});

// 提交代码到新分支
await createOrUpdateFile({
  owner: "username",
  repo: "my-project",
  path: "src/feature.js",
  content: "// 新功能代码",
  message: "Add new feature",
  branch: "feature/new-feature"
});

// 创建 Pull Request
await createPullRequest({
  owner: "username",
  repo: "my-project",
  title: "添加新功能",
  head: "feature/new-feature",
  base: "main",
  body: "## 变更说明\n- 添加了新功能\n- 更新了文档"
});

3. Issue Management

// 创建 Issue
const issue = await createIssue({
  owner: "username",
  repo: "my-project",
  title: "修复登录问题",
  body: "## 问题描述\n用户无法登录\n\n## 复现步骤\n1. 打开登录页面\n2. 输入凭证\n3. 点击登录",
  labels: ["bug", "high-priority"],
  assignees: ["developer1"]
});

// 添加评论
await addIssueComment({
  owner: "username",
  repo: "my-project",
  issue_number: issue.number,
  body: "正在调查此问题"
});

// 更新 Issue
await updateIssue({
  owner: "username",
  repo: "my-project",
  issue_number: issue.number,
  state: "closed",
  labels: ["bug", "fixed"]
});

4. Code Review

// 获取 PR 详情
const pr = await getPullRequest({
  owner: "username",
  repo: "my-project",
  pull_number: 123
});

// 获取 PR 文件变更
const files = await getPullRequestFiles({
  owner: "username",
  repo: "my-project",
  pull_number: 123
});

// 创建审查
await createPullRequestReview({
  owner: "username",
  repo: "my-project",
  pull_number: 123,
  body: "代码看起来不错，有几点建议",
  event: "COMMENT",
  comments: [
    {
      path: "src/index.js",
      line: 10,
      body: "建议添加错误处理"
    }
  ]
});

// 合并 PR
await mergePullRequest({
  owner: "username",
  repo: "my-project",
  pull_number: 123,
  merge_method: "squash",
  commit_title: "feat: 添加新功能"
});

5. Search and Query

// 搜索代码
const codeResults = await searchCode({
  q: "function login repo:username/my-project"
});

// 搜索 Issue
const issueResults = await searchIssues({
  q: "is:open label:bug repo:username/my-project",
  sort: "created",
  order: "desc"
});

// 搜索仓库
const repoResults = await searchRepositories({
  query: "react stars:>1000 language:javascript"
});

GitHub Actions Integration

Automated Testing

name: CI
on: [push, pull_request]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Run tests
        run: npm test

Automated Deployment

name: Deploy
on:
  push:
    branches: [main]
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Deploy
        run: ./deploy.sh

Integration Scenarios

1. Automated Code Review

• Listen to PR creation events
• Run code quality checks
• Automatically add review comments
• Mark areas that need improvement

2. Automatic Issue Classification

• Listen to Issue creation events
• Analyze Issue content
• Automatically add labels
• Assign to appropriate personnel

3. Release Management

• Listen to version tag events
• Generate change logs
• Create GitHub Release
• Notify team members

4. Dependency Update

• Regularly check for dependency updates
• Create update PRs
• Run tests for verification
• Automatically merge security updates

Notes

• Comply with GitHub API rate limits
• Use Personal Access Token for authentication
• Properly handle API errors and retries
• Protect sensitive information and keys
• Follow open source project contribution guidelines