{"id":16123582,"url":"https://github.com/austenstone/spellchecker-cli-action-summary","last_synced_at":"2025-06-15T15:11:50.357Z","repository":{"id":106376807,"uuid":"532112800","full_name":"austenstone/spellchecker-cli-action-summary","owner":"austenstone","description":"An Action that creates job summaries, status checks, and issues for markdown spelling errors reported by tbroadley/spellchecker-cli. Spell Check","archived":false,"fork":false,"pushed_at":"2023-07-19T21:55:38.000Z","size":1199,"stargazers_count":5,"open_issues_count":5,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-17T06:41:10.653Z","etag":null,"topics":["actions","spell","spellcheck"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/spellchecker-cli","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/austenstone.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["austenstone"]}},"created_at":"2022-09-03T00:12:50.000Z","updated_at":"2024-02-20T13:54:23.000Z","dependencies_parsed_at":"2024-10-27T18:14:07.824Z","dependency_job_id":"23994408-8f89-47ff-94a7-eae89d6e76a9","html_url":"https://github.com/austenstone/spellchecker-cli-action-summary","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":"austenstone/action-typescript","purl":"pkg:github/austenstone/spellchecker-cli-action-summary","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/austenstone%2Fspellchecker-cli-action-summary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/austenstone%2Fspellchecker-cli-action-summary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/austenstone%2Fspellchecker-cli-action-summary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/austenstone%2Fspellchecker-cli-action-summary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/austenstone","download_url":"https://codeload.github.com/austenstone/spellchecker-cli-action-summary/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/austenstone%2Fspellchecker-cli-action-summary/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259995022,"owners_count":22943314,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","spell","spellcheck"],"created_at":"2024-10-09T21:17:31.064Z","updated_at":"2025-06-15T15:11:50.295Z","avatar_url":"https://github.com/austenstone.png","language":"TypeScript","funding_links":["https://github.com/sponsors/austenstone"],"categories":[],"sub_categories":[],"readme":"# Action\nAn [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).\n\n## Issue \u0026 Job Summary\nGet 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`.\n\n![image](https://user-images.githubusercontent.com/22425467/188254502-5f07ea12-f65e-4956-b46e-62645e63b02e.png)\n\n## Status Checks\nStatus checks will be reported if the event is of type `pull_request`.\n### Annotations\nThe 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).\n\n![image](https://user-images.githubusercontent.com/22425467/188254398-e1d99d0b-bc40-4787-b1fc-898b6ebf2a4e.png)\n\n\u003e **Note**\n\u003e \u003cbr\u003eThe check may fail with annotations if the exact line number and columns aren't output.\u003cbr\u003eSee open issue https://github.com/tbroadley/spellchecker-cli/issues/102\n\n## Dictionary\nYou can use a dictionary located at `.github/dictionary.txt` to ignore words from the spell check.\n```txt\nGitHub\nGit\nKubernetes\nSpotify\n```\n### Slash commands\nYou can use slash commands to add to the dictionary from issues or prs.\n\n![image](https://user-images.githubusercontent.com/22425467/188254700-5e917a37-42fc-45be-bd5e-05775d7aa1ce.png)\n\n![image](https://user-images.githubusercontent.com/22425467/188254718-e5c41d9b-5df5-4e73-8525-5d1e60dbe1ea.png)\n\n### Workflow Dispatch\nOr you can run it from the Actions workflow page.\n\n![image](https://user-images.githubusercontent.com/22425467/188254746-905428af-050f-483a-ab51-9280e78d722d.png)\n\n### Protected branches\nIf the branch is protected a pull request will be opened.\n\n\u003cimg width=\"518\" alt=\"Screen Shot 2022-09-03 at 12 12 17 AM\" src=\"https://user-images.githubusercontent.com/22425467/188255438-d97a54e2-9505-48c5-b937-de715b2b3838.png\"\u003e\n\n#### Triggering runs\nWorkflows 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.\n\n## Usage\nCreate 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).\n\n#### Reusable Workflow Example\nUse the reusable workflow [`spellcheck.yml`](.github/workflows/spellcheck.yml) to easily implement this action in your repository.\n```yml\nname: Spell Check .md\non:\n  schedule:\n    - cron: \"0 0 1 * *\"\n\njobs:\n  spellcheck:\n    uses: austenstone/spellchecker-cli-action-summary/.github/workflows/spellcheck.yml@main\n```\n#### Reusable Workflow Example Dictionary Add\nYou can also add dictionary functionality.\n```yml\nname: Spell Check Dictionary Add\non:\n  workflow_dispatch:\n    inputs:\n      words:\n        type: string\n        description: Words to add to the dictionary\n        required: true\n\njobs:\n  spellcheck:\n    uses: austenstone/spellchecker-cli-action-summary/.github/workflows/spellcheck-dictionary-add.yml@main\n    with:\n      words: ${{ inputs.words }}\n```\n\n## ➡️ Inputs\nVarious inputs are defined in [`action.yml`](action.yml):\n\n| Name | Description | Default |\n| --- | - | - |\n| github-token | Token to use to authorize. | ${{ github-token }} |\n| file-json | JSON file containing the list of files to check. | ${{ file-json }} |\n| files-changed | List of files to check. | ${{ files-changed }} |\n\n\u003c!-- \n## ⬅️ Outputs\n| Name | Description |\n| --- | - |\n| output | The output. |\n--\u003e\n\n## Further help\nTo get more help on the Actions see [documentation](https://docs.github.com/en/actions).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faustenstone%2Fspellchecker-cli-action-summary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faustenstone%2Fspellchecker-cli-action-summary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faustenstone%2Fspellchecker-cli-action-summary/lists"}