https://github.com/ernanej/code-guardian-ci

[WIP] Code review action based on prompts in ChatGPT.
https://github.com/ernanej/code-guardian-ci

chatgpt code-review

Last synced: about 2 months ago
JSON representation

[WIP] Code review action based on prompts in ChatGPT.

• Host: GitHub
• URL: https://github.com/ernanej/code-guardian-ci
• Owner: ErnaneJ
• License: mit
• Created: 2023-12-19T01:09:53.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-30T02:42:38.000Z (9 months ago)
• Last Synced: 2024-10-24T21:59:10.203Z (3 months ago)
• Topics: chatgpt, code-review
• Language: JavaScript
• Homepage:
• Size: 1.04 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Code Guardian CI GitHub Action

🤖 **AI-powered Automated Code Reviewer**

![Code Guardian CI](./assets/preview-code-guardian-ci.jpeg)

See this review comment [here](https://github.com/ErnaneJ/code-guardian-ci/pull/4#pullrequestreview-1795629618).

## Description

Code Guardian CI is an automated code review GitHub Action that leverages the power of ChatGPT to provide insightful feedback on your pull requests. This action uses prompts in ChatGPT to analyze your code changes and offers suggestions to improve code quality.

## Usage

To integrate Code Guardian CI into your workflow, add the following YAML configuration to your GitHub Actions workflow file (e.g., `.github/workflows/code-guardian-ci.yml`):

```yaml

name: Code Guardian CI

on:

  pull_request:

    types:

      - opened

      - synchronize

jobs:

  code-guardian-ci:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout Repository

        uses: actions/checkout@v2

      - name: Run Code Guardian CI

        uses: ErnaneJ/code-guardian-ci-action@v1

        with:

          owner: ${{ github.repository_owner }}

          repo: ${{ github.event.repository.name }}

          pr_number: ${{ github.event.number }}

          token_g: ${{ secrets.GITHUB_TOKEN }}

          token_oia: ${{ secrets.OPENIA_API_TOKEN }}

```

## Inputs

- **owner** (required): The owner of the repository.

- **repo** (required): The name of the repository.

- **pr_number** (required): The number of the pull request.

- **token_g** (required): The token to use to access the GitHub API.

- **token_oia** (required): The token to use to access the OpenIA API.

## Example

```yaml

uses: your-username/code-guardian-ci-action@v1

with:

  owner: 'your-username'

  repo: 'your-repository'

  pr_number: 123

  token_g: ${{ secrets.GITHUB_TOKEN }}

  token_oia: ${{ secrets.OPENIA_API_TOKEN }}

```

## License

This GitHub Action is licensed under the [MIT License](LICENSE). 📜