refactor GH actions - #593
Conversation
WalkthroughRefactors GitHub Actions CI/CD by moving Python version matrices from .github/shared-vars.yml into the load-shared-vars action with renamed outputs ( Changes
Possibly related PRs
Pre-merge checks and finishing touches❌ Failed checks (2 inconclusive)
✅ Passed checks (1 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Organization UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (18)
🔇 Additional comments (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #593 +/- ##
=======================================
Coverage 99.92% 99.92%
=======================================
Files 129 129
Lines 11272 11272
=======================================
Hits 11264 11264
Misses 8 8
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
.github/actions/load-shared-vars/action.yml (1)
21-30: Eliminate duplication by defining arrays once.The Python version arrays are duplicated between
GITHUB_ENV(lines 23-24) andGITHUB_OUTPUT(lines 28-29). If these values need updating, both locations must be changed, creating a maintenance risk.🔎 Proposed refactor to eliminate duplication
run: | + PYTHON_TEST_MATRIX='["3.11","3.12","3.13","3.14"]' + PYTHON_MIN_DEPS_MATRIX='["3.13","3.14"]' + { echo "PYTHON_DEFAULT=3.13" - echo 'PYTHON_TEST_MATRIX=["3.11","3.12","3.13","3.14"]' - echo 'PYTHON_MIN_DEPS_MATRIX=["3.13","3.14"]' + echo "PYTHON_TEST_MATRIX=${PYTHON_TEST_MATRIX}" + echo "PYTHON_MIN_DEPS_MATRIX=${PYTHON_MIN_DEPS_MATRIX}" } >> "$GITHUB_ENV" { - echo 'python-test-matrix=["3.11","3.12","3.13","3.14"]' - echo 'python-min-deps-matrix=["3.13","3.14"]' + echo "python-test-matrix=${PYTHON_TEST_MATRIX}" + echo "python-min-deps-matrix=${PYTHON_MIN_DEPS_MATRIX}" } >> "$GITHUB_OUTPUT".pre-commit-config.yaml (1)
35-38: Good addition for linting GitHub Actions workflows.Adding actionlint aligns well with the PR's objective to refactor GitHub Actions and will help catch workflow errors early during pre-commit.
Note: v1.6.27 is valid, but the project is actively maintained with v1.7.9 available as of November 2025. Consider updating to the latest version for bug fixes and improvements.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (12)
.github/actions/load-shared-vars/action.yml.github/shared-vars.yml.github/workflows/build_deploy_master_docs.yaml.github/workflows/build_deploy_stable_docs.yaml.github/workflows/get_coverage.yml.github/workflows/lint.yml.github/workflows/profile.yml.github/workflows/run_min_dep_tests.yml.github/workflows/runtests.yml.github/workflows/test_doc_build.yml.github/workflows/upload_pypi.yml.pre-commit-config.yaml
💤 Files with no reviewable changes (1)
- .github/shared-vars.yml
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (18)
- GitHub Check: test_code (windows-latest, 3.13)
- GitHub Check: test_code (windows-latest, 3.12)
- GitHub Check: test_code (windows-latest, 3.14)
- GitHub Check: test_code (ubuntu-latest, 3.14)
- GitHub Check: test_code (ubuntu-latest, 3.11)
- GitHub Check: test_code (ubuntu-latest, 3.13)
- GitHub Check: test_code (macos-latest, 3.14)
- GitHub Check: test_code (windows-latest, 3.11)
- GitHub Check: test_code (macos-latest, 3.13)
- GitHub Check: test_code (ubuntu-latest, 3.12)
- GitHub Check: test_code (macos-latest, 3.11)
- GitHub Check: test_code_min_deps (ubuntu-latest, 3.13)
- GitHub Check: test_code_min_deps (macos-latest, 3.14)
- GitHub Check: test_code_min_deps (macos-latest, 3.13)
- GitHub Check: test_code_min_deps (windows-latest, 3.14)
- GitHub Check: test_code_min_deps (windows-latest, 3.13)
- GitHub Check: test_code_min_deps (ubuntu-latest, 3.14)
- GitHub Check: Run benchmarks
🔇 Additional comments (11)
.github/workflows/profile.yml (1)
25-25: Documentation comment improves maintainability.The added comment clearly documents the source of the
PYTHON_DEFAULTvariable, making it easier for maintainers to locate and update version configurations..github/workflows/upload_pypi.yml (1)
26-26: Documentation comment improves maintainability.The added comment clearly documents the source of the
PYTHON_DEFAULTvariable..github/workflows/test_doc_build.yml (1)
23-23: Documentation comment improves maintainability.The added comment clearly documents the source of the
PYTHON_DEFAULTvariable..github/workflows/get_coverage.yml (1)
22-22: Documentation comment improves maintainability.The added comment clearly documents the source of the
PYTHON_DEFAULTvariable..github/workflows/build_deploy_stable_docs.yaml (1)
38-38: Documentation comment improves maintainability.The added comment clearly documents the source of the
PYTHON_DEFAULTvariable..github/workflows/lint.yml (1)
25-25: Documentation comment improves maintainability.The added comment clearly documents the source of the
PYTHON_DEFAULTvariable..github/workflows/build_deploy_master_docs.yaml (1)
43-43: Documentation comment improves maintainability.The added comment clearly documents the source of the
PYTHON_DEFAULTvariable..github/workflows/run_min_dep_tests.yml (2)
26-26: Documentation comments improve maintainability.The added comments clearly document the source of the Python version matrices, making the workflow easier to understand and maintain.
Also applies to: 30-30, 45-45
31-31: Outputpython-min-deps-matrixis correctly defined.The
.github/actions/load-shared-vars/action.ymlfile defines this output with description "Python version matrix for minimum dependency tests". The workflow reference is valid..github/workflows/runtests.yml (2)
28-37: LGTM! Clear documentation and correct output references.The added comments clearly document where the Python version matrix is defined, and the output reference correctly uses the renamed
python-test-matrixkey with proper step id reference.
47-48: Good documentation addition.The inline comment helpfully points developers to the source of the Python version matrix definition.
CodSpeed Performance ReportMerging #593 will not alter performanceComparing Summary
|
Description
This PR attempts to clean up the GH actions.
Checklist
I have (if applicable):
Summary by CodeRabbit
Chores
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.