https://github.com/infraspecdev/spellcheck-action

This GitHub Action checks spelling and grammar in markdown files, leveraging OpenAI GPT model, and posts comments directly on pull requests highlighting the issues found.
https://github.com/infraspecdev/spellcheck-action

automation code-review grammar-check openai spell-checker

Last synced: 3 days ago
JSON representation

This GitHub Action checks spelling and grammar in markdown files, leveraging OpenAI GPT model, and posts comments directly on pull requests highlighting the issues found.

• Host: GitHub
• URL: https://github.com/infraspecdev/spellcheck-action
• Owner: infraspecdev
• License: mit
• Created: 2024-10-10T09:04:33.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-21T12:49:53.000Z (about 1 month ago)
• Last Synced: 2024-11-21T13:37:52.789Z (about 1 month ago)
• Topics: automation, code-review, grammar-check, openai, spell-checker
• Language: Python
• Homepage:
• Size: 78.1 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Spell Check and Grammar Check GitHub Action

This GitHub Action checks spelling and grammar in markdown files, leveraging OpenAI GPT model, and posts comments directly on pull requests highlighting the issues found.

## Usage

To use this action in your workflow, add the following step to your `.github/workflows/spell_check.yml` file:

```yaml

jobs:

  spellcheck:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout repository

        uses: actions/checkout@v3

      - name: Run Spell Check

        uses: infraspecdev/spellcheck-action@

        with:

          openai_api_key: ${{ secrets.OPENAI_API_KEY }}

          github_token: ${{ secrets.GITHUB_TOKEN }}

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

          files: 'blogs/file1.md, blogs/file2.md'

          openai_model: '' #Optional

          model_max_token:  #Optional