Skip to content

README.md

Latest commit

 

History

History
103 lines (75 loc) · 2.28 KB

README.md

File metadata and controls

103 lines (75 loc) · 2.28 KB
Raw

B4Bot

B4Bot is an agent-based project management bot for GitHub repositories. It reviews repository code on a scheduled or manual GitHub Actions trigger and creates scoped management issues.

MVP Behavior

Default issue generation policy:

  • Run once per week by default.
  • Maintain up to 12 open B4Bot issues.
  • Manage four scopes: feature, error, refactor, secure.
  • Create up to 3 open issues per scope.
  • Skip a scope when that scope already has 3 open B4Bot issues.
  • Skip the whole run when 12 open B4Bot issues already exist.
  • Add a priority label to each generated issue.

The defaults can be overridden in the target repository configuration.

Target Repository Setup

Add a workflow to the target repository:

name: B4Bot Review

on:
  schedule:
    - cron: "0 0 * * 1"
  workflow_dispatch:

permissions:
  contents: read
  issues: write

jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: Blueprint4Agent/B4Bot@v1
        with:
          config-path: ".github/b4bot.yml"
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          B4BOT_PROVIDER_API_KEY: ${{ secrets.B4BOT_PROVIDER_API_KEY }}

Add .github/b4bot.yml to the target repository:

issuePolicy:
  maxTotalOpenIssues: 12
  perScope:
    feature: 3
    error: 3
    refactor: 3
    secure: 3
  botLabel: "b4bot"

provider:
  name: "mock"
  model: "mock"

Providers

The MVP includes:

  • mock: deterministic provider for workflow validation
  • openai: API-backed provider using the user's B4BOT_PROVIDER_API_KEY

claude and copilot are reserved provider names and will be implemented after the MVP.

Documentation

  • English operating docs are maintained under docs/.
  • Korean translations mirror the repository structure under notes/ko/.
  • Trigger behavior, inputs, outputs, and diagrams are documented in docs/operation-flow.md.

Examples:

  • AGENTS.md -> notes/ko/AGENTS.md
  • README.md -> notes/ko/README.md
  • docs/configuration.md -> notes/ko/docs/configuration.md
  • docs/operation-flow.md -> notes/ko/docs/operation-flow.md

Development

Requirements:

  • Node.js 20 or newer
  • npm

Commands:

npm install
npm run typecheck
npm run build

The compiled GitHub Action entrypoint is dist/index.js.