Skip to content

docs: note that tests/smoketest.sh is not run by any CI workflow - #715

Open
UgaTheDev wants to merge 2 commits into
instructlab:mainfrom
UgaTheDev:docs/note-smoketest-sh-orphaned
Open

UgaTheDev wants to merge 2 commits into
instructlab:mainfrom
UgaTheDev:docs/note-smoketest-sh-orphaned

Conversation

@UgaTheDev

Copy link
Copy Markdown

docs/ci.md points at tests/smoketest.sh under "Smoke tests" without
saying whether CI runs it. It doesn't: smoke.yaml invokes
tox -e py3-smoke, which (tox.ini) runs pytest tests/smoke, never
tests/smoketest.sh. The script still covers axes the pytest matrix doesn't
(flash-attention on/off, Granite on/off, FSDP+LoRA), so it's not redundant —
just orphaned and easy to mistake for something CI already checks.

This adds one sentence making that explicit and pointing at #705, where the
consolidation question (fold smoketest.sh's cases into
test_training_feature_matrix, or delete it) is still open and needs a
maintainer decision — actually reconciling the two test surfaces is a bigger
change than a docs PR should carry.

Originally flagged in #705 (comment from 2026-07-29): "There's a second smoke test nobody runs... No workflow calls it anymore, since smoke.yaml invokes tox -e py3-smoke which only points at tests/smoke/. It's dead as far as CI goes but still checked in and still exercising real coverage."

One-line diff, docs/ci.md only.

docs/ci.md pointed at tests/smoketest.sh without saying whether CI runs
it. It doesn't: smoke.yaml runs tox -e py3-smoke, which only invokes
pytest tests/smoke, never smoketest.sh. The script still covers axes
the pytest matrix doesn't (flash-attention, Granite, FSDP+LoRA), so
it's orphaned rather than redundant. Notes that explicitly and points
at instructlab#705 where the consolidation question is still open.

Ref: instructlab#705

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Signed-off-by: Kush Zingade <kush.zingade@gmail.com>
@coderabbitai

coderabbitai Bot commented Aug 24, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 59 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 251c5692-3b9d-4178-81bb-9828fa9776a4
Commits

Reviewing files that changed from the base of the PR and between da76404 and cbfc060.

Files selected for processing: 1

  • docs/ci.md
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

Share

@Maxusmusti Maxusmusti left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The headline is correct — no workflow invokes tests/smoketest.sh (smoke.yaml and smoke-py312.yaml both go through the run-smoke action → tox -e py3-smoke → pytest tests/smoke). But the added sentence overstates what the script still covers:

  • The script is broken, not just orphaned. test_standard_loop passes --is_granite, which was removed from main_ds.py's argparse in #257, so parse_args() exits with "unrecognized arguments". The script runs with set -eux -o pipefail, so it aborts there and test_standard_loop_fsdp_lora (run after it in main()) is never reached. The script hasn't been touched since 2024-11.
  • "Granite on/off" isn't a real axis anymore — every test uses instructlab/granite-7b-lab; the on/off was just that removed flag.
  • Flash-attention off and FSDP+LoRA genuinely aren't covered by the pytest smoke matrix, so that part is fair — but FSDP+LoRA isn't actually reachable in the script today.
  • Smaller points: it names only smoke.yaml (there's also smoke-py312.yaml), and pointing docs at an issue for coverage details will go stale once #705 is closed.

Suggested wording:

There is also a Shell-based smoke test script at tests/smoketest.sh. It is not run by any CI workflow and is currently stale (e.g. it passes the removed --is_granite flag); see #705.

The script passes the removed --is_granite flag, so it does not
exercise the coverage the previous wording claimed.

Signed-off-by: Kush Zingade <kush.zingade@gmail.com>
@UgaTheDev

Copy link
Copy Markdown
Author

Thanks for the detailed check. I replaced the sentence with your wording: the script is not run by any CI workflow and is currently stale (e.g. it passes the removed --is_granite flag), see #705. Pushed.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants