https://github.com/austenstone/spellchecker-cli-action-summary
An Action that creates job summaries, status checks, and issues for markdown spelling errors reported by tbroadley/spellchecker-cli. Spell Check
https://github.com/austenstone/spellchecker-cli-action-summary
actions spell spellcheck
Last synced: about 1 year ago
JSON representation
An Action that creates job summaries, status checks, and issues for markdown spelling errors reported by tbroadley/spellchecker-cli. Spell Check
- Host: GitHub
- URL: https://github.com/austenstone/spellchecker-cli-action-summary
- Owner: austenstone
- Created: 2022-09-03T00:12:50.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-19T21:55:38.000Z (almost 3 years ago)
- Last Synced: 2025-05-17T06:41:10.653Z (about 1 year ago)
- Topics: actions, spell, spellcheck
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/spellchecker-cli
- Size: 1.14 MB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Action
An [Action](https://docs.github.com/en/actions) that creates job summaries, status checks, and issues for markdown spelling errors reported by [tbroadley/spellchecker-cli](https://github.com/tbroadley/spellchecker-cli).
## Issue & Job Summary
Get a table of all the misspelled words with suggested fixes and links directly to the file/line. The job summary is always created and the issue summary is created if the job is not of event type `push` or `pull_request`. The issue summary contains all misspelled words but the job summary only contains results from the files that have changed if the event is of type `push` or `pull_request`.
## Status Checks
Status checks will be reported if the event is of type `pull_request`.
### Annotations
The status checks contain inline annotations that will appear in the files changed view of the pull request. See [Getting started with the Checks API](https://docs.github.com/en/rest/guides/getting-started-with-the-checks-api).
> **Note**
>
The check may fail with annotations if the exact line number and columns aren't output.
See open issue https://github.com/tbroadley/spellchecker-cli/issues/102
## Dictionary
You can use a dictionary located at `.github/dictionary.txt` to ignore words from the spell check.
```txt
GitHub
Git
Kubernetes
Spotify
```
### Slash commands
You can use slash commands to add to the dictionary from issues or prs.
### Workflow Dispatch
Or you can run it from the Actions workflow page.
### Protected branches
If the branch is protected a pull request will be opened.
#### Triggering runs
Workflows cannot be triggered from other workflows like the dictionary add with the default `GITHUB_TOKEN`. Consider using one of the techniques outlines in [Triggering further workflow runs](https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md#triggering-further-workflow-runs) by @peter-evans.
## Usage
Create a workflow (eg: `.github/workflows/seat-count.yml`). See [Creating a Workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).
#### Reusable Workflow Example
Use the reusable workflow [`spellcheck.yml`](.github/workflows/spellcheck.yml) to easily implement this action in your repository.
```yml
name: Spell Check .md
on:
schedule:
- cron: "0 0 1 * *"
jobs:
spellcheck:
uses: austenstone/spellchecker-cli-action-summary/.github/workflows/spellcheck.yml@main
```
#### Reusable Workflow Example Dictionary Add
You can also add dictionary functionality.
```yml
name: Spell Check Dictionary Add
on:
workflow_dispatch:
inputs:
words:
type: string
description: Words to add to the dictionary
required: true
jobs:
spellcheck:
uses: austenstone/spellchecker-cli-action-summary/.github/workflows/spellcheck-dictionary-add.yml@main
with:
words: ${{ inputs.words }}
```
## ➡️ Inputs
Various inputs are defined in [`action.yml`](action.yml):
| Name | Description | Default |
| --- | - | - |
| github-token | Token to use to authorize. | ${{ github-token }} |
| file-json | JSON file containing the list of files to check. | ${{ file-json }} |
| files-changed | List of files to check. | ${{ files-changed }} |
## Further help
To get more help on the Actions see [documentation](https://docs.github.com/en/actions).