pr-agent-wiki-conf's Introduction

pr-agent-wiki-conf

Community version of PR-Agent Wiki configuration file

Why?

PR-Agent Wiki configuration file feature is currently only available in the paid version (PR-Agent Pro)
This Composite Action provides functionality similar to the PR-Agent Wiki Configuration feature as Open Source
Provides functionality to make it easier to set and manage common extra_instructions

How does it work

Note: current support is extra_instructions config only

Load .pr_agent.toml configuration from Wiki page
Merge common_instructions and the env extra_instructions with the Wiki config value
Set each extra_instructions to environment variables

How to Use

Example of .pr_agent.toml
See details GitHub Actions

on:
  pull_request:
    types: [opened, reopened, ready_for_review]
  issue_comment:
jobs:
  pr_agent_job:
    if: ${{ github.event.sender.type != 'Bot' }}
    runs-on: ubuntu-latest
    permissions:
      issues: write
      pull-requests: write
      contents: write
    steps:
      - name: PR-Agent Wiki Configuration
        uses: idubnori/pr-agent-wiki-conf@main
        env:
          common_instructions: >-
            - Answer in Japanese.
          pr_reviewer.extra_instructions: >-
            - Additional second priority point: focus on the need for test code additions or changes to the application code changes.
      - name: PR Agent action step
        id: pragent
        uses: Codium-ai/pr-agent@main
        env:
          OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Recommend Projects