Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add codespell workflow #2807

Merged
merged 9 commits into from
Aug 30, 2024
39 changes: 39 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: codespell

on:
push:
branches:
- master
workflow_dispatch:
pull_request_target:
branches:
- master

jobs:
codespell:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
if: github.event_name != 'pull_request_target'

- name: Checkout pull/${{ github.event.number }}
uses: actions/checkout@v4
with:
fetch-depth: 0
ref: ${{ github.event.pull_request.head.sha }}
if: github.event_name == 'pull_request_target'

- name: Setup micromamba
uses: mamba-org/setup-micromamba@v1
with:
environment-name: fetch-env
create-args: >-
python

- name: Install Codespell
run: pip install codespell

- name: Run codespell
run: |
codespell docs/
6 changes: 5 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -214,4 +214,8 @@ sort_commits = "newest"

[tool.git-cliff.remote.github]
owner = "tardis-sn"
repo = "tardis"
repo = "tardis"

[tool.codespell]
skip = "*.png,*.ggb,*.jpg,*.gif,*.ico,docs/contributing/CHANGELOG.md,docs/tardis.bib"
quiet-level = 3
Loading