name: Test GitHub Action
on: [pull_request]
jobs:
run:
name: Spell Check with Typos
runs-on: ubuntu-latest
steps:
- name: Use custom config file
uses: crate-ci/typos@master
with:
files: ./file.txt
config: ./myconfig.toml
typos
Source code spell checker
Typos-action is an action detecting and fixing source code misspellings. It's fast enough, so even in big repositories, it will be a great fit and is designed to make false positives to a minimum. So it can be run on pull requests reliably.
- Handling False Positives: This will be pretty useful for both names or domain-specific language, thus making it relatively easy to modify its sensitivity by editing the
typos.tomlfile to ignore some words or patterns. Integrations: It offers integrations with GitHub Actions, comes complete with pre-commit hooks, and even offers a Visual Studio Code extension.
It gives the commands to dump configurations or see certain components of your text for further debugging or customizing. You might even get output in different formats like JSON, such that you can process the data in other tools with ease.
This seems quite priceless to keep the quality of the code without burdening manual spell checking. This is very helpful, especially for such teams to work on huge codebases and open source contributions, where consistency in naming and documentation is key.
Monitoring GitHub Actions Workflows
CICube is a GitHub Actions monitoring tool that provides you with detailed insights into your workflows to further optimize your CI/CD pipeline. With CICube, you will be able to track your workflow runs, understand where the bottlenecks are, and tease out the best from your build times. Go to cicube.io now and create a free account to better optimize your GitHub Actions workflows!
