Repository navigation
docs: fix reusable workflow example - #528
Open
j45856021-dev wants to merge 1 commit into
Open
j45856021-dev wants to merge 1 commit into
j45856021-dev wants to merge 1 commit into
Conversation
Replace the removed check-code workflow with the existing typing and pre-commit workflows. Keep actions-ref only on the typing call. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
j45856021-dev
requested review from
ethanwharris,
justusschock and
tchaton
as code owners
October 14, 2026 04:19
Borda
approved these changes
Oct 20, 2026
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #528 +/- ##
=====================================
Coverage ? 72%
=====================================
Files ? 17
Lines ? 749
Branches ? 0
=====================================
Hits ? 540
Misses ? 209
Partials ? 0 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation-only changes match the existing workflow interfaces, with no unresolved issues.
No open issues 🎉
What changed in this PR
Updates the README’s reusable-workflow example to reflect the split of code checks into typing and pre-commit workflows.
Changes:
- Replaces the removed
check-code.ymlreference with both current workflows. - Keeps
actions-refonly on the typing job; leaves the schema job unchanged.
| File | Description |
|---|---|
| README.md | Corrects reusable-workflow references and inputs. |
Review effort: Balanced
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Before submitting
README.md.What does this PR do?
The reusable-workflow example still calls
check-code.yml@main, which was removed when #191 split typing and pre-commit checks. Copying that example therefore references a nonexistent workflow.Use
check-typing.ymlandcheck-precommit.yml, matching the existingci-use-checks.yaml. Keepactions-refonly on the typing call because the pre-commit workflow does not declare that input. The pinned schema job is unchanged; no workflow definitions or Python code change.Validation
-W --keep-going; the doctest target contains zero tests. The rendered HTML contains the exact updated YAML.No GitHub Actions workflow was dispatched for validation. This is an automated contribution; no human review is claimed.