8000 Optimize GitHub Actions Workflow and Add Spell Checking by seantomburke · Pull Request #174 · seantomburke/sitemapper · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Optimize GitHub Actions Workflow and Add Spell Checking #174

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

Merged
merged 6 commits into from
May 16, 2025

Conversation

seantomburke
Copy link
Owner
@seantomburke seantomburke commented May 16, 2025

Overview

This PR optimizes our GitHub Actions workflow for better visibility and performance, while also adding spell checking to improve code quality.

GitHub Actions Improvements

  • Separate Jobs: Split monolithic build job into specialized jobs (build, type-check, eslint, prettier, spellcheck, tests)
  • 🚀 Performance: Added build artifact caching between jobs using GitHub's cache action
  • 📦 Dependency Caching: Implemented efficient npm caching based on package-lock.json hash
  • 🧩 Simplified Configuration: Consolidated workflows by removing the separate typescript-test.yml file
  • 🎯 Focused Testing: Linting jobs use single Node version (20.x) while maintaining full version testing (18.x-24.x) for runtime tests

Spell Checking Integration

  • 📝 Code Quality: Added cspell for code and documentation spell checking
  • 🔍 New Scripts: Created dedicated lint:spell script
  • 🔄 Integration: Updated main lint process to include spell checking

Script Improvements

  • 🧪 Test Organization: Separated Mocha tests into dedicated test:js script
  • ⚙️ Better Sequencing: Enhanced main test script to properly sequence all checks
  • 👍 Compatibility: Maintained backward compatibility with existing test commands

These changes improve developer experience by providing clearer feedback on test failures in the GitHub UI while also improving CI performance through intelligent caching.

- Update CodeQL actions from v2 to v3

- Replace deprecated actions/create-release@v1 with softprops/action-gh-release@v2

- Fix deprecated set-output syntax in version-bump.yml
@pull-request-size pull-request-size bot added size/L and removed size/M labels May 16, 2025
@seantomburke seantomburke changed the title Update GitHub Actions and add spell checking Optimize GitHub Actions workflow and add spell checking May 16, 2025
@seantomburke seantomburke changed the title Optimize GitHub Actions workflow and add spell checking Optimize GitHub Actions Workflow and Add Spell Checking May 16, 2025
@seantomburke seantomburke merged commit 69de147 into master May 16, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant
0