Skip to content

automation.md

Latest commit

 

History

History
285 lines (214 loc) · 6.65 KB

automation.md

File metadata and controls

285 lines (214 loc) · 6.65 KB

Automation System

← Back to Main

This document explains the automated systems that keep this repository up-to-date using Claude Code, GitHub Actions, and MCP integrations.

Table of Contents

Overview

This repository uses two automated systems:

System Trigger Purpose
Weekly Auto-Update GitHub Actions (cron) Research and add new AI coding tools
Auto-Translation Claude Code Hook Sync Korean/Japanese translations

Weekly Auto-Update:

flowchart LR
    A[GitHub Actions] --> B[Claude Code] --> C[Perplexity MCP] --> D[Update README] --> E[Create PR]
Loading

Auto-Translation:

flowchart LR
    A[Edit README.md] --> B[Hook] --> C[translate] --> D[Agents] --> E[ko + ja]
Loading

Weekly Auto-Update System

How It Works

The weekly update system automatically researches and adds new AI coding tools to the README.

sequenceDiagram
    participant GHA as GitHub Actions
    participant CC as Claude Code
    participant MCP as Perplexity MCP
    participant Repo as Repository

    GHA->>GHA: Trigger (Sunday 00:00 UTC)
    GHA->>CC: Start headless mode
    CC->>Repo: Read README.md
    CC->>MCP: Search "latest AI coding tools 2025"
    MCP-->>CC: Return search results
    CC->>CC: Compare with existing entries
    CC->>Repo: Add new tools to README.md
    CC->>CC: Run translate command
    CC->>Repo: Update README.ko.md, README.ja.md
    CC-->>GHA: Changes complete
    GHA->>Repo: Create Pull Request
Loading

Workflow Configuration

File: .github/workflows/weekly-update.yml

name: Weekly README Update

on:
  schedule:
    - cron: '0 0 * * 0'  # Every Sunday at 00:00 UTC
  workflow_dispatch:     # Manual trigger
    inputs:
      category:
        description: 'Category to update'
        default: 'all'

Categories

Category Section Search Query
ide IDE & Editor Assistants AI coding IDE tools 2025
agentic Agentic Coding Environments Autonomous AI coding agents 2025
cloud Cloud & Platform Integrations AI cloud development platforms 2025
learning Learning Resources Vibe coding research papers articles 2025
all All sections All of the above

Manual Trigger

  1. Go to Actions tab in GitHub
  2. Select Weekly README Update
  3. Click Run workflow
  4. Optionally select a specific category

Auto-Translation System

How It Works

When README.md is edited, a hook automatically triggers translation to Korean and Japanese.

flowchart TB
    A[User edits README.md] --> B{PostToolUse Hook}
    B -->|Edit or Write tool| C[translate-readme.sh]
    C --> D[Output instruction]
    D --> E[Claude reads instruction]
    E --> F[Execute translate]
    F --> G[Read README.md]
    G --> H[Parallel Agents]
    H --> I[Agent 1: Korean]
    H --> J[Agent 2: Japanese]
    I --> K[README.ko.md]
    J --> L[README.ja.md]
Loading

Translation Modes

The /translate command supports two modes:

flowchart TB
    A[translate command] --> B{Mode?}

    B -->|Default| C[Incremental Sync]
    C --> C1[Read both files]
    C1 --> C2[Find differences]
    C2 --> C3[Translate only new items]
    C3 --> C4[Insert at same position]

    B -->|Full| D[Full Translation]
    D --> D1[Read README.md]
    D1 --> D2[Translate entire file]
    D2 --> D3[Overwrite target file]
Loading

Hook Configuration

File: .claude/settings.json

{
  "hooks": {
    "PostToolUse": [
      {
        "matcher": "Edit|Write",
        "hooks": [
          {
            "type": "command",
            "command": "\"$CLAUDE_PROJECT_DIR/.claude/hooks/translate-readme.sh\""
          }
        ]
      }
    ]
  }
}

Translation Command

File: .claude/commands/translate.md

The command instructs Claude to:

  1. Read README.md and target language file
  2. Identify new/modified/deleted items
  3. Translate and insert at the exact same position
  4. Preserve markdown formatting, links, and code blocks

Translation Rules

Rule Example
Keep technical terms Claude Code, MCP, GitHub Actions
Keep URLs unchanged [Website](https://example.com)
Preserve table structure | Tool | Description |
Add space after bold (Korean) **텍스트** 다음

Configuration Files

File Structure

.claude/
├── commands/
│   └── translate.md      # Translation command definition
├── hooks/
│   └── translate-readme.sh  # Hook script for auto-translation
├── mcp.json              # MCP server configuration
└── settings.json         # Claude Code settings

.github/
├── prompts/
│   └── weekly-update.md  # Update prompt template
└── workflows/
    └── weekly-update.yml # GitHub Actions workflow

MCP Configuration

File: .claude/mcp.json

{
  "mcpServers": {
    "perplexity-ask": {
      "command": "npx",
      "args": ["-y", "@anthropic-ai/mcp-perplexity"],
      "env": {
        "PERPLEXITY_API_KEY": "${PERPLEXITY_API_KEY}"
      }
    }
  }
}

Setup Guide

Prerequisites

  • GitHub repository with Actions enabled
  • Anthropic API key
  • Perplexity API key

Step 1: Set GitHub Secrets

gh secret set ANTHROPIC_API_KEY --body "your-key"
gh secret set PERPLEXITY_API_KEY --body "your-key"

Step 2: Enable GitHub Actions

  1. Go to repository Settings
  2. Navigate to Actions → General
  3. Enable "Allow all actions and reusable workflows"

Step 3: Test Manual Trigger

  1. Go to Actions tab
  2. Select Weekly README Update
  3. Click Run workflow
  4. Monitor the workflow execution

Step 4: Verify Auto-Translation

  1. Make a small edit to README.md using Claude Code
  2. Observe the hook output message
  3. Confirm translations are updated

Troubleshooting

Weekly Update Issues

Issue Solution
Workflow not running Check cron syntax and Actions permissions
API key errors Verify secrets are correctly set
No changes detected Check if new tools were found
PR creation failed Verify contents: write permission

Translation Issues

Issue Solution
Hook not triggering Verify settings.json configuration
Wrong file detected Check file path matching in hook script
Translation incomplete Ensure both files are readable

← Back to Main