Pull Requests

Note: The Pull Request processing currently is limited only to editing existing code. More complex interactions and features are in development.

Overview

CodeMaker AI code code editing capabilities can used directly from the GitHub Pull Requests. This feature can be enabled after configuring CodeMaker Pull Request Action for your GitHub repository.

The action defines the following properties:

• access-token - GitHub Personal Access Token (PAT).

• api-key - unique API Key needed to invoke the service. Should be stored as a secret.

The GitHub Action can be triggered upon pull request code review and will process all of the comments automatically.

Example

Create a new GitHub workflow under ./github/workflows named code-review.yml with the following content.

name: Auto update PR based on a comment

on:
  pull_request_review:
    types: [submitted]

concurrency:
  group: ${{ github.workflow }} - ${{ github.event.pull_request.head.ref }}

jobs:
  update_pr_job:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          ref: ${{ env.HEAD_BRANCH }}
      - name: Code Review Action
        uses: codemakerai/[email protected]
        with:
          access-token: ${{ secrets.GITHUB_TOKEN }}
          api-key: ${{ secrets.CODEMAKER_API_KEY }}

This will enable the code editing capabilities within GitHub Pull Requests. The workflow will be automatically triggered upon creation of a code review.