Skip to content
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.

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

[docs-infra] Test the link check script #43200

Open
alexfauquette opened this issue Aug 6, 2024 · 2 comments
Open

[docs-infra] Test the link check script #43200

alexfauquette opened this issue Aug 6, 2024 · 2 comments
Assignees
Labels
core Infrastructure work going on behind the scenes ready to take Help wanted. Guidance available. There is a high chance the change will be accepted scope: docs-infra Specific to the docs-infra product test

Comments

@alexfauquette
Copy link
Member

alexfauquette commented Aug 6, 2024

          The cleanest way I can think of would be to extract the script logic into packages-internal/scripts, test it there and leave just the CLI in the scripts directory.

Originally posted by @michaldudak in #43144 (comment)

For context, the script which takes care of verifying each internal link point to an existing page, and an existing anchor was doing nothing (except eating some CPU time)

It would be nice to have a test that ensures it fails

The idea would be to have two markdown files, one with broken links, one with ok links, and run test that ensure the script is failing on the correct one and passing the other one.

This should avoid the issue we got with the script silently failing because it detected no link

Search keywords:

@github-actions github-actions bot added the status: waiting for maintainer These issues haven't been looked at yet by a maintainer label Aug 6, 2024
@zannager zannager added the scope: docs-infra Specific to the docs-infra product label Aug 6, 2024
@zannager zannager assigned michaldudak and DiegoAndai and unassigned michaldudak Aug 6, 2024
@DiegoAndai
Copy link
Member

Hey @alexfauquette, what needs to be fixed specifically?

@DiegoAndai DiegoAndai added test core Infrastructure work going on behind the scenes and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer test labels Aug 23, 2024
@alexfauquette
Copy link
Member Author

This issue is about testing the script is working as expected.

The idea would be to have two markdown files, one with broken links, one with ok links, and run test that ensure the script is failing on the correct one and passing the other one.

This should avoid the issue we got with the script silently failing because it detected no link

@DiegoAndai DiegoAndai added ready to take Help wanted. Guidance available. There is a high chance the change will be accepted test labels Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Infrastructure work going on behind the scenes ready to take Help wanted. Guidance available. There is a high chance the change will be accepted scope: docs-infra Specific to the docs-infra product test
Projects
None yet
Development

No branches or pull requests

4 participants