Skip to content

Commit d61464a

Browse files
committed
chore: tweaks before release
1 parent 1e9b2ed commit d61464a

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ This action can be used to perform automatic code-reviews or write reviewer guid
1616
| `publish` | Whether to publish the review as PR comments || `true` |
1717
| `exclude` | File patterns to exclude (e.g. '*.md *.json package-lock.json') || `""` (none) |
1818
| `config` | Path to lgtm.toml configuration file (e.g. '.lgtm.toml') || `""` (none) |
19+
| `output-format` | Output format for the review (pretty, json, markdown) || `""` (default) |
1920
| `verbose` | Enable extra verbose output (-vv instead of -v) || `false` |
2021

2122
### Quick Usage
@@ -43,7 +44,6 @@ on:
4344
4445
jobs:
4546
lgtm-review:
46-
needs: check-permission
4747
if: |
4848
github.event.issue.pull_request &&
4949
startsWith(github.event.comment.body, '/lgtm review')
@@ -57,12 +57,12 @@ jobs:
5757
- name: Run LGTM Review
5858
uses: elementsinteractive/lgtm-ai-action@v1
5959
with:
60-
ai-api-key: ${{ secrets.AI_API_TOKEN }}
60+
ai-api-key: ${{ secrets.AI_API_KEY }}
6161
git-api-key: ${{ secrets.GITHUB_TOKEN }}
6262
pr-number: ${{ github.event.issue.number }}
6363
model: 'gpt-5'
6464
```
6565

6666
> [!TIP]
6767
> The action will autodiscover any `lgtm.toml` file in your repository so you can
68-
> fully configure `lgtm-ai`. See the [configuration documentation](https://github.com/elementsinteractive/lgtm-ai?tab=readme-ov-file#configuration).
68+
> fully configure `lgtm-ai`. For that, you will need to use the `actions/checkout` action in your workflow. See the [configuration documentation](https://github.com/elementsinteractive/lgtm-ai?tab=readme-ov-file#configuration) for more information about how to configure `lgtm-ai`.

action.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ description: "AI-powered code reviewer for pull requests"
33
author: "Elements Interactive"
44

55
branding:
6-
icon: "moon"
6+
icon: "search"
77
color: "blue"
88

99
inputs:
@@ -43,16 +43,16 @@ inputs:
4343
required: false
4444
default: ""
4545

46-
verbose:
47-
description: "Enable extra verbose output (-vv instead of -v)"
48-
required: false
49-
default: "false"
50-
5146
output-format:
5247
description: "Output format for the review (pretty, json, markdown)"
5348
required: false
5449
default: ""
5550

51+
verbose:
52+
description: "Enable extra verbose output (-vv instead of -v)"
53+
required: false
54+
default: "false"
55+
5656
runs:
5757
using: "composite"
5858
steps:

0 commit comments

Comments
 (0)