add readme entry and github action input

This commit is contained in:
Mark Arts 2024-02-29 09:34:12 +01:00 committed by GitHub
parent 50095030c4
commit 247088e438
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 5 additions and 0 deletions

View file

@ -43,6 +43,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # The GITHUB_TOKEN is there by default so you just need to keep it like it is and not necessarily need to add it as secret as it will throw an error. [More Details](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret) GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # The GITHUB_TOKEN is there by default so you just need to keep it like it is and not necessarily need to add it as secret as it will throw an error. [More Details](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret)
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }} OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
OPENAI_API_MODEL: "gpt-4" # Optional: defaults to "gpt-4" OPENAI_API_MODEL: "gpt-4" # Optional: defaults to "gpt-4"
EXTRA_INSTRUCTIONS: "- never comment on file formatting and linting issues" # Optional: defaults to ""
exclude: "**/*.json, **/*.md" # Optional: exclude patterns separated by commas exclude: "**/*.json, **/*.md" # Optional: exclude patterns separated by commas
``` ```

View file

@ -11,6 +11,10 @@ inputs:
description: "OpenAI API model." description: "OpenAI API model."
required: false required: false
default: "gpt-4" default: "gpt-4"
EXTRA_INSTRUCTIONS:
description: "Extra instructions to be added to the text prompt."
required: false
default: ""
exclude: exclude:
description: "Glob patterns to exclude files from the diff analysis" description: "Glob patterns to exclude files from the diff analysis"
required: false required: false