Skip to content

fix(docs): Skip Fern bash-script tests on Windows #2017

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tgasser-nv merged 1 commit into from
Jun 12, 2026
+8 −0
Merged

fix(docs): Skip Fern bash-script tests on Windows #2017

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions tests/test_docs_links.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,14 @@
# limitations under the License.

import os
import platform
import shutil
import subprocess
import tempfile
from pathlib import Path

import pytest

REPO_ROOT = Path(__file__).resolve().parents[1]
CHECK_DOCS_LINKS = REPO_ROOT / "scripts" / "check-docs-links.sh"

Expand All @@ -38,6 +41,7 @@ def run_link_check(file_path: Path, env: dict[str, str] | None = None) -> subpro
)


@pytest.mark.skipif(platform.system() == "Windows", reason="bash script not available on Windows")
def test_reports_broken_local_markdown_links_with_source_line_numbers(
Comment thread
tgasser-nv marked this conversation as resolved.
tmp_path: Path,
) -> None:
Expand Down Expand Up @@ -67,6 +71,7 @@ def test_reports_broken_local_markdown_links_with_source_line_numbers(
assert "inside-code-fence.md" not in output


@pytest.mark.skipif(platform.system() == "Windows", reason="bash script not available on Windows")
def test_ignores_links_inside_inline_code_and_html_comments(tmp_path: Path) -> None:
md_path = tmp_path / "guide.md"
md_path.write_text(
Expand All @@ -90,6 +95,7 @@ def test_ignores_links_inside_inline_code_and_html_comments(tmp_path: Path) -> N
assert "inside-comment.md" not in output


@pytest.mark.skipif(platform.system() == "Windows", reason="bash script not available on Windows")
def test_resolves_guardrails_fern_routes(tmp_path: Path) -> None:
md_path = tmp_path / "guide.mdx"
md_path.write_text(
Expand All @@ -112,6 +118,7 @@ def test_resolves_guardrails_fern_routes(tmp_path: Path) -> None:
assert result.returncode == 0, output


@pytest.mark.skipif(platform.system() == "Windows", reason="bash script not available on Windows")
def test_rejects_mdx_suffixes_for_links_that_resolve_as_fern_routes() -> None:
temp_dir = Path(tempfile.mkdtemp(prefix="check-docs-route-suffix-", dir=REPO_ROOT / "docs"))
try:
Expand Down Expand Up @@ -161,6 +168,7 @@ def test_rejects_mdx_suffixes_for_links_that_resolve_as_fern_routes() -> None:
shutil.rmtree(temp_dir)


@pytest.mark.skipif(platform.system() == "Windows", reason="bash script not available on Windows")
def test_fails_loudly_on_malformed_html_comments(tmp_path: Path) -> None:
md_path = tmp_path / "guide.md"
md_path.write_text(
Expand Down
Loading