action.yml

name: "ChatGPT GitHub Actions"
description: "This GitHub Action automates code review for pull requests using OpenAI's GPT models. By integrating this action into your CI/CD pipeline, it provides detailed, AI-generated reviews of your code directly within the PR comments. This tool helps maintain code quality, ensures adherence to best practices, and highlights potential improvements and bugs."
inputs:
  openai_api_key:  # id of input
    description: 'OpenAI API Key'
    required: true
    default: ''
  github_token:  # id of input
    description: 'Github API Key'
    required: true
    default: ''
  github_pr_id:  # id of input
    description: 'Github PR ID'
    required: true
    default: ''
  openai_model:
    description: "The OpenAI model to use for generating responses. Examples: 'gpt-3.5-turbo', 'gpt-4'"
    required: false
    default: "gpt-3.5-turbo"
  openai_temperature:
    description: "The temperature for OpenAI responses. Controls the creativity of the responses. Higher values (e.g., 0.9) make output more random, while lower values (e.g., 0.1) make it more focused and deterministic."
    required: false
    default: "0.5"
  openai_max_tokens:
    description: "The maximum number of tokens to generate in the OpenAI response. Example: 1000"
    required: false
    default: "2048"
  mode:
    description: "The mode of operation for the action. Options: 'files' to review file changes, 'patch' to review the patch changes."
    required: false
    default: "files"
  language:
    description: "The language for the code review"
    required: false
    default: "en"  # English as the default language
  custom_prompt:
    description: "Custom prompt to use for generating responses. If not provided, a default prompt will be used based on the mode."
    required: false
    default: ""
runs:
  using: "docker"
  image: "Dockerfile"
  env:
    OPENAI_API_KEY: ${{ inputs.openai_api_key }}
    GITHUB_TOKEN: ${{ inputs.github_token }}
    GITHUB_PR_ID: ${{ inputs.github_pr_id }}
    OPENAI_MODEL: ${{ inputs.openai_model }}
    OPENAI_TEMPERATURE: ${{ inputs.openai_temperature }}
    OPENAI_MAX_TOKENS: ${{ inputs.openai_max_tokens }}
    MODE: ${{ inputs.mode }}
    LANGUAGE: ${{ inputs.language }} 
    CUSTOM_PROMPT: ${{ inputs.custom_prompt }}