spellcheck-action/action.yml at main · infraspecdev/spellcheck-action · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
name: 'Spell Check and Grammar Check Action'
description: 'A GitHub Action to check spelling and grammar in markdown files using OpenAI GPT-4, posting comments on pull requests.'

author: 'RR'
branding:
  color: 'green'
  icon: 'cloud-lightning'

inputs:
  openai_api_key:
    description: 'OpenAI API Key'
    required: true
    type: string

  github_repository:
    description: 'The name of the GitHub repository'
    required: true
    type: string

  github_token:
    description: 'GitHub Token to post comments on the pull request'
    required: true
    type: string

  openai_model:
    description: 'OpenAI model to be used for spelling and grammar check'
    default: "gpt-4o"
    type: string

  model_max_token:
    description: 'Max token to be assigned to the model'
    default: 16000
    type: number

  pr_number:
    description: 'Pull request number where comments will be posted'
    required: true
    type: string

  files:
    description: 'Comma-separated list of markdown files to check for spelling and grammar'
    required: true
    type: string

  fail_on_spelling:
    description: 'Fail the PR if any spelling errors are found'
    default: true
    type: boolean

  fail_on_grammar:
    description: 'Fail the PR if any grammar errors are found'
    default: false
    type: boolean

  log_level:
    description: 'Log level for the action (e.g., DEBUG, INFO, WARN, ERROR)'
    default: "ERROR"
    type: string

  default_language:
    description: 'Default language for spell checking'
    default: 'en-US'
    type: string

runs:
  using: 'docker'
  image: 'Dockerfile'

permissions:
  contents: read
  pull-requests: write