File tree Expand file tree Collapse file tree 1 file changed +28
-0
lines changed
Expand file tree Collapse file tree 1 file changed +28
-0
lines changed Original file line number Diff line number Diff line change 1+ # Update spell-check workflow to automatically create PRs for spelling fixes
2+
3+ This PR updates the ` .github/workflows/spell-check.yml ` workflow to automatically create pull requests for spelling corrections.
4+
5+ ## Changes:
6+
7+ - ** Split workflow into two jobs:**
8+ - ` codespell-check ` : Runs on pull requests to verify spelling (check-only mode)
9+ - ` codespell-fix ` : Runs weekly or manually to fix spelling and create PRs
10+
11+ - ** New triggers:**
12+ - ` schedule ` : Runs automatically every Sunday at midnight UTC
13+ - ` workflow_dispatch ` : Allows manual triggering from the Actions tab
14+ - ` pull_request ` : Still checks PRs but doesn't auto-fix them
15+
16+ - ** Automated PR creation:**
17+ - Runs codespell with ` -w ` flag to auto-fix issues
18+ - Uses ` peter-evans/create-pull-request@v6 ` to create PRs
19+ - Creates PRs on branch ` automated/spelling-fixes `
20+ - Adds labels: ` documentation ` , ` automated `
21+
22+ ## How to use:
23+
24+ - ** Automatic** : Wait for the weekly Sunday run
25+ - ** Manual** : Go to Actions → codespell → Run workflow
26+ - ** PR checks** : Still validates spelling on every pull request
27+
28+ The workflow has proper permissions (` contents: write ` , ` pull-requests: write ` ) to create commits and PRs.
You can’t perform that action at this time.
0 commit comments