akiojin/Auto Review by OpenAI
This action is an automated review action using OpenAI or Azure OpenAI.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| openai-api-key | Specify the API key for OpenAI. | yes | — |
| model | Specifies the ChatGPT model to be used. ex) gpt-4o, gpt-4o-mini, o3-mini | no | o3-mini |
| github-token | Specify a GitHub token. By default, github.token is specified. | yes | ${{ github.token }} |
| target | Specify the extension of the file to be reviewed. If there are multiple files, specify them separated by commas. ex) md,txt,ts | yes | — |
| language | Specify the language in which the comments will be written. This value should be specified in plain language. ex) 日本語 | yes | English |
| max-tokens | The maximum number of tokens to generate. By default, 3000. | no | — |
| temperature | The sampling temperature to use that controls the apparent creativity of generated completions. Higher values will make output more random while lower values will make results more focused and deterministic. It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict. | no | — |
| top-p | An alternative to sampling with temperature called nucleus sampling. This value causes the model to consider the results of tokens with the provided probability mass. As an example, a value of 0.15 will cause only the tokens comprising the top 15% of probability mass to be considered. It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict. | no | — |
| resource-name | Specify the resource name when using Azure OpenAI. The resource name corresponds to the <resource name> in the URL of the Azure OpenAI resource. https://<resource name>.openai.azure.com/ | no | — |
| deployment-id | Specify a deployment name when using Azure OpenAI. | no | — |
| optimize | Specifies whether to optimize the review of pull requests. If optimized, only the differences from the parent commit are reviewed. If not optimized, all differences from the base branch are reviewed. | no | true |
| display-suggestions | You can specify whether to display improvement suggestions. ex) false | yes | true |
| api-version | When using Azure OpenAI, you must specify the API version to be used. | no | — |
Outputs
| name | description |
|---|---|
| output | Outputs the results of the auto-review. |