Skip to content

fix: make mkdocs CLI exception test reach prepare_docs#4867

Open
immanuwell wants to merge 1 commit into
kubernetes-sigs:mainfrom
immanuwell:fix-mkdocs-cli-test
Open

fix: make mkdocs CLI exception test reach prepare_docs#4867
immanuwell wants to merge 1 commit into
kubernetes-sigs:mainfrom
immanuwell:fix-mkdocs-cli-test

Conversation

@immanuwell
Copy link
Copy Markdown

What type of PR is this?

/kind test

What this PR does / why we need it:

Tiny MkDocs CLI test fix. The exception-path test mocked prepare_docs, but then ran main() without a temp --docs-dir, so it bailed on missing site-src before the mock was reached. Oops, test never hit the thing it said it was testing.

Repro on origin/main:

PYTHONPATH=hack python -m unittest discover -s hack/mkdocs/__tests__ -p 'test_cli.py' -k test_main_handles_prepare_docs_exceptions

Before: AssertionError: Exception not raised.
After: the test reaches the mocked prepare_docs and passes. No cloud/API limits or quotas involved here; this is just local CLI arg handling.

Which issue(s) this PR fixes:

None. Related to #3999 and #3860.

Does this PR introduce a user-facing change?:

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/test labels May 15, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: immanuwell
Once this PR has been reviewed and has the lgtm label, please assign danwinship for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot requested review from aojea and rikatz May 15, 2026 14:41
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Welcome @immanuwell!

It looks like this is your first PR to kubernetes-sigs/gateway-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/gateway-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 15, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Hi @immanuwell. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

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

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/test needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants