Skip to content

docs: fix reusable workflow example - #528

Open
j45856021-dev wants to merge 1 commit into
Lightning-AI:mainfrom
j45856021-dev:docs/readme-reusable-check-workflows
Open

j45856021-dev wants to merge 1 commit into
Lightning-AI:mainfrom
j45856021-dev:docs/readme-reusable-check-workflows

Conversation

@j45856021-dev

Copy link
Copy Markdown
Before submitting
  • Was this discussed/agreed via a Github issue? Not applicable: this is a documentation improvement, as exempted by the template.
  • Did you read the contributor guideline, Pull Request section?
  • Documentation updated in README.md.
  • Did all existing and newly added tests pass locally? The full Python suite was not run for this README-only change; scoped checks are listed below.

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.yml and check-precommit.yml, matching the existing ci-use-checks.yaml. Keep actions-ref only 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

  • Seven local YAML checks pass, covering referenced workflow files, declared input names/types, the unchanged schema job and negative controls. The original example fails on the missing workflow and missing split jobs.
  • Pinned Markdown formatting, codespell and applicable README hygiene checks pass. Hooks ran directly because the full pre-commit launcher is unavailable in this environment.
  • Sphinx HTML, doctest and linkcheck targets pass with -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.

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>
@Borda Borda added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 20, 2026
@Borda
Borda requested a balanced review from Copilot October 20, 2026 08:01
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@9a53be8). Learn more about missing BASE report.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 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.yml reference with both current workflows.
  • Keeps actions-ref only 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

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants