Evaluates the code written as part of a pull request to assess its complexity and provide a score on the effort required to put it together. It will then leave a comment on the PR with the response from Maxium's server and delete any previous comments from the same action.

To integrate Maxium with your Actions pipeline, specify the name of this repository with a tag number / branch (@v1.0.0-beta.1 is recommended) as a step within your workflow.yml file.

This Action also requires you to provide a Maxium API key which you can get by signing up here. (tip: in order to avoid exposing your token, store it as a secret).

Inside your .github/workflows/workflow.yml file:

name: Maxium Code Eval

on:
  pull_request:
    types:
      - opened
      - synchronizd

jobs:
  code-eval:
    runs-on: self-hosted
      timeout-minutes: 5
    steps:
      - name: Maxium Code Eval Action
        uses: maxium-ai/code-eval-action@master
        with:
          github-token: "${{ secrets.GITHUB_TOKEN }}"
          maxium-ai-api-key: "${{ secrets.MAXIUM_AI_API_KEY }}"

Maxium's Code Eval Action supports the v1/code-eval/pull-request endpoint. The endpoint takes the following inputs as part of the request body to evaluate code changes: