Skip to content

Commit

Permalink
Change action name and branding
Browse files Browse the repository at this point in the history
  • Loading branch information
skylus committed May 11, 2023
1 parent d9d1501 commit 4eba049
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 12 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# chatgpt-reviewer-github-action
# chatgpt-code-reviewer

GitHub action that adds ChatGPT code review comments to pull requests. This service uses the GitHub REST API and the OpenAI API to generate suggestions for pull request changes.

Expand All @@ -17,13 +17,13 @@ To use this github action, you will need to have a GitHub account and an OpenAI

1. Visit https://platform.openai.com/account/api-keys to generate a new OpenAI API key.
2. Add new key with a name `OPENAI_API_KEY` as described [here](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository). As a value set generated OpenAi Api key from the step 1
3. In a repository you want to run this action, create a file: `.github/workflows/chatgpt-reviewer-github-action.yml` with the next content:
3. In a repository you want to run this action, create a file: `.github/workflows/chatgpt-code-reviewer.yml` with the next content:
```yml
name: chatgpt-reviewer-github-action
run-name: chatgpt-reviewer-github-action
name: chatgpt-code-reviewer
run-name: chatgpt-code-reviewer
on: [pull_request]
jobs:
chatgpt-reviewer-github-action:
chatgpt-code-reviewer:
runs-on: ubuntu-latest
steps:
- name: ChatGPT Review
Expand Down
10 changes: 7 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: chatgpt-reviewer-github-action
description: GitHub action that provides a service for adding review comments to a pull request on GitHub
author: MagnifiCode
name: chatgpt-code-reviewer
description: GitHub action that adds ChatGPT code review comments to pull requests
author: MagnifiCode (https://magnificode.net)
inputs:
model:
description: 'OpenAI model'
Expand All @@ -9,3 +9,7 @@ inputs:
runs:
using: node16
main: dist/index.js
branding:
icon: 'award'
color: 'yellow'

4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "chatgpt-reviewer-github-action",
"version": "0.0.5",
"name": "chatgpt-code-reviewer",
"version": "0.0.6",
"description": "GitHub action that provides a service for adding review comments to a pull request on GitHub.",
"main": "dist/index.js",
"scripts": {
Expand Down

0 comments on commit 4eba049

Please sign in to comment.