Skip to content

feat: Adding codespell workflow #4173

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.

Sign up for GitHub

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

Merged
yhakbar merged 6 commits into from
Apr 17, 2025
Merged

feat: Adding codespell workflow #4173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
99d1d44
feat: Add `codespell` workflow to GitHub Actions
yhakbar Apr 17, 2025
7bc7196
feat: Removing `codespell` from CircleCI
yhakbar Apr 17, 2025
ad3286d
feat: Adding `MISE_PYTHON_DEFAULT_PACKAGES_FILE` to set default packa…
yhakbar Apr 17, 2025
aa3bafb
Merge remote-tracking branch 'origin/main' into feat/adding-codespell…
yhakbar Apr 17, 2025
fe5b157
fix: Also run on push to `main`
yhakbar Apr 17, 2025
dc0d680
Merge branch 'main' into feat/adding-codespell-workflow
yhakbar Apr 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 0 additions & 23 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,12 +144,6 @@ run_markdownlint: &run_markdownlint
-- \
docs

codespell: &codespell
name: Run codespell
command: |
pip install codespell==2.4.0
codespell .

win_install_golang: &win_install_golang
name: Install golang
shell: powershell.exe
Expand Down Expand Up @@ -642,13 +636,6 @@ jobs:
- run:
<<: *run_markdownlint

codespell:
<<: *defaults
steps:
- checkout
- run:
<<: *codespell

build:
resource_class: xlarge
<<: *defaults
Expand Down Expand Up @@ -976,16 +963,6 @@ workflows:
- AWS__PHXDEVOPS__circle-ci-test
- GCP__automated-tests
- GITHUB__PAT__gruntwork-ci
- codespell:
filters:
tags:
only:
- /^v.*/
- /^alpha.*/
context:
- AWS__PHXDEVOPS__circle-ci-test
- GCP__automated-tests
- GITHUB__PAT__gruntwork-ci
- build:
filters:
tags:
Expand Down
36 changes: 36 additions & 0 deletions .github/workflows/codespell.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Codespell

on:
push:
branches:
- main
pull_request:
types: [opened, synchronize, reopened]

jobs:
codespell:
name: Check Spelling
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Create default packages file
run: |
cat <<EOF > .mise-python-default-packages
codespell==2.4.0
Copy link
Copy Markdown
Member

@denis256 denis256 Apr 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why can't we add codespell to mise? And install it directly? because it will bring Python dependencies?

Copy link
Copy Markdown
Collaborator Author

@yhakbar yhakbar Apr 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIK, there isn't a codespell mise/asdf plugin that we can use.

What this does is have mise install python, then install the codespell package immediately afterwards.

EOF

echo "MISE_PYTHON_DEFAULT_PACKAGES_FILE=.mise-python-default-packages" >> "$GITHUB_ENV"

- name: Use mise to install dependencies
uses: jdx/mise-action@v2
with:
version: 2025.4.4
mise_toml: |
[tools]
python = "3.13.3"

- name: Run codespell
run: codespell .