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

ci: add markdown link check job #30034

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

willcl-ark
Copy link
Member

Potential followup to: #30025

This should prevent us reintroducing broken markdown links.

It does not test "online" (external) links, only those within this repo. Both relative and absolute links are parsed successfully if they resolve.

@DrahtBot
Copy link
Contributor

DrahtBot commented May 3, 2024

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Code Coverage

For detailed information about the code coverage, see the test coverage report.

Reviews

See the guideline for information on the review process.

Type Reviewers
ACK maflcko

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

Conflicts

No conflicts as of last run.

@DrahtBot DrahtBot added the Tests label May 3, 2024
@willcl-ark
Copy link
Member Author

Without #30025 (or alternative fix) the new action being added here will fail.
It takes ~11s to run:

.github/workflows/ci.yml Outdated Show resolved Hide resolved
@DrahtBot
Copy link
Contributor

DrahtBot commented May 7, 2024

🚧 At least one of the CI tasks failed. Make sure to run all tests locally, according to the
documentation.

Possibly this is due to a silent merge conflict (the changes in this pull request being
incompatible with the current code in the target branch). If so, make sure to rebase on the latest
commit of the target branch.

Leave a comment here, if you need help tracking down a confusing failure.

Debug: https://github.com/bitcoin/bitcoin/runs/24698006837

test/lint/test_runner/src/main.rs Outdated Show resolved Hide resolved
ci/lint/04_install.sh Outdated Show resolved Hide resolved
test/lint/test_runner/src/main.rs Outdated Show resolved Hide resolved
test/lint/test_runner/src/main.rs Outdated Show resolved Hide resolved
Copy link
Member

@maflcko maflcko left a comment

Choose a reason for hiding this comment

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

utACK

test/lint/test_runner/src/main.rs Outdated Show resolved Hide resolved
@willcl-ark willcl-ark marked this pull request as ready for review May 8, 2024 10:23
@maflcko
Copy link
Member

maflcko commented May 8, 2024

utACK 9d2a8a8

with or without the nits

This adds a markdown hyperlink check task to the lint test_runner. It
relies on having the [`mlc`](https://crates.io/crates/mlc) binary found
on $PATH, but will fail with `success` if the binary is not found.

`mlc` is also added to the ci/04_install.sh script run by the
containerfile.

Note that broken markdown hyperlinks will be detected in untracked
markdown files found in a dirty working directory (including e.g.
.venv).
@willcl-ark
Copy link
Member Author

Thanks @maflcko , did a final force-push for that silly nit: git range-diff 9d2a8a8...82c5f95

Sorry to invalidate the ACK

@maflcko
Copy link
Member

maflcko commented May 8, 2024

utACK 82c5f95

Thanks!

@DrahtBot DrahtBot removed the CI failed label May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants