infraspecdev/Spell Check and Grammar Check Action
A GitHub Action to check spelling and grammar in markdown files using OpenAI GPT-4, posting comments on pull requests.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| openai_api_key | OpenAI API Key | yes | — |
| github_repository | The name of the GitHub repository | yes | — |
| github_token | GitHub Token to post comments on the pull request | yes | — |
| openai_model | OpenAI model to be used for spelling and grammar check | — | gpt-4o |
| model_max_token | Max token to be assigned to the model | — | 16000 |
| pr_number | Pull request number where comments will be posted | yes | — |
| files | Comma-separated list of markdown files to check for spelling and grammar | yes | — |
| fail_on_spelling | Fail the PR if any spelling errors are found | — | true |
| fail_on_grammar | Fail the PR if any grammar errors are found | — | false |
| log_level | Log level for the action (e.g., DEBUG, INFO, WARN, ERROR) | — | ERROR |
| default_language | Default language for spell checking | — | en-US |
Outputs
no outputs