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.

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

Jump to bottom

Add CI job for finding invalid links in markdown files #1244

Merged
merged 12 commits into from
Aug 2, 2021
Merged

Add CI job for finding invalid links in markdown files #1244

merged 12 commits into from
Aug 2, 2021

Conversation

rnbguy
Copy link
Member

@rnbguy rnbguy commented Jul 28, 2021

Closes: Broken Markdown links

Description

Adds CI for finding invalid links in markdown files.

For contributor use:

  • Added a changelog entry, using unclog.
  • If applicable: Unit tests written, added test to CI.
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Updated relevant documentation (docs/) and code comments.
  • Re-reviewed Files changed in the Github PR explorer.

@rnbguy
Copy link
Member Author

rnbguy commented Jul 28, 2021

@adizere hey. I created the CI. but it seems, many of the tests failed because Github started sending 429 for too many requests. looks like, I have to create a config file. any idea where I should put it?

ref. https://github.com/marketplace/actions/markdown-link-check#too-many-requests

@romac
Copy link
Member

romac commented Jul 29, 2021

I would put it somewhere in the .github folder and then use the config-file option of the action to point to it (not clear what the path there is relative to though, guess it requires some trial and error).

@adizere
Copy link
Member

adizere commented Jul 29, 2021 •
edited
Loading

@adizere hey. I created the CI. but it seems, many of the tests failed because Github started sending 429 for too many requests. looks like, I have to create a config file. any idea where I should put it?

ref. https://github.com/marketplace/actions/markdown-link-check#too-many-requests

Many thanks Rano!

+1 for Romain's suggestion! I took the liberty to try and see if it works with the config file (8ee6d44), but seems there are still failures. Weird enough the failures appear for crates.io website (which works).

Not sure how to fix it, a debugging ideas would be to use the variables:

        use-quiet-mode: 'yes'
        use-verbose-mode: 'yes'

Any thoughts @rnbguy?

@rnbguy
Copy link
Member Author

rnbguy commented Jul 29, 2021 •
edited
Loading

Yeah I noticed that about crates.io in first commit too. They are probably blocking the requests too. Add an ignorePatterns for crates.io. crates.io links will probably never change.

@romac romac changed the title Added markdown-link-check Add CI job for finding invalid links in markdown files Jul 29, 2021
@rnbguy
Copy link
Member Author

rnbguy commented Jul 30, 2021

The CI is in better shape now. The errors seem to be genuine. I fixed some of them. Currently, there are 3 links that are failing.

adizere
adizere approved these changes Aug 2, 2021
View reviewed changes
Copy link
Member

@adizere adizere left a comment

Choose a reason for hiding this comment

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

This was very helpful, cool work Rano!

@adizere adizere merged commit f4aa4b4 into master Aug 2, 2021
@adizere adizere deleted the rnbguy/markdown-link-check branch August 2, 2021 13:15
adizere added a commit that referenced this pull request Aug 2, 2021
@rnbguy @adizere
Add CI job for finding invalid links in markdown files (#1244)
03d63cd 
* Added markdown-link-check

* Update changelog

* Added config file

* Added ignore pattern for crates.io, simplified output

* Added ignore pattern for localhost

* Fix ignore patterns in markdown-link-check config

* Better Github relative link for directory

* Fix Github relative links within the project

* Fixed two broken links

* Fixed last broken link

* Reverted changelog

* Removed pending changelog file

Co-authored-by: Adi Seredinschi <adi@informal.systems>
adizere added a commit that referenced this pull request Aug 2, 2021
@adizere @romac @rnbguy
Fix for regression #1229 using new type ics02::TrustThreshold (#1254)
6d170f4 
* Fix for regression #1229 using new type ics02::TrustThreshold

* Cleanup

* changelog

* Apply suggestions from code review

Co-authored-by: Romain Ruetschi <romain@informal.systems>

* Add CI job for finding invalid links in markdown files (#1244)

* Added markdown-link-check

* Update changelog

* Added config file

* Added ignore pattern for crates.io, simplified output

* Added ignore pattern for localhost

* Fix ignore patterns in markdown-link-check config

* Better Github relative link for directory

* Fix Github relative links within the project

* Fixed two broken links

* Fixed last broken link

* Reverted changelog

* Removed pending changelog file

Co-authored-by: Adi Seredinschi <adi@informal.systems>

Co-authored-by: Romain Ruetschi <romain@informal.systems>
Co-authored-by: Ranadeep Biswas <ranadeep@informal.systems>
hu55a1n1 pushed a commit to hu55a1n1/hermes that referenced this pull request Sep 13, 2022
@rnbguy @adizere
Add CI job for finding invalid links in markdown files (informalsyste…
228b2ca 
…ms#1244)

* Added markdown-link-check

* Update changelog

* Added config file

* Added ignore pattern for crates.io, simplified output

* Added ignore pattern for localhost

* Fix ignore patterns in markdown-link-check config

* Better Github relative link for directory

* Fix Github relative links within the project

* Fixed two broken links

* Fixed last broken link

* Reverted changelog

* Removed pending changelog file

Co-authored-by: Adi Seredinschi <adi@informal.systems>
hu55a1n1 pushed a commit to hu55a1n1/hermes that referenced this pull request Sep 13, 2022
@adizere @romac @rnbguy
Fix for regression informalsystems#1229 using new type ics02::TrustTh…
01a8e38 
…reshold (informalsystems#1254)

* Fix for regression informalsystems#1229 using new type ics02::TrustThreshold

* Cleanup

* changelog

* Apply suggestions from code review

Co-authored-by: Romain Ruetschi <romain@informal.systems>

* Add CI job for finding invalid links in markdown files (informalsystems#1244)

* Added markdown-link-check

* Update changelog

* Added config file

* Added ignore pattern for crates.io, simplified output

* Added ignore pattern for localhost

* Fix ignore patterns in markdown-link-check config

* Better Github relative link for directory

* Fix Github relative links within the project

* Fixed two broken links

* Fixed last broken link

* Reverted changelog

* Removed pending changelog file

Co-authored-by: Adi Seredinschi <adi@informal.systems>

Co-authored-by: Romain Ruetschi <romain@informal.systems>
Co-authored-by: Ranadeep Biswas <ranadeep@informal.systems>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adizere adizere adizere approved these changes

@ancazamfir ancazamfir Awaiting requested review from ancazamfir

@romac romac Awaiting requested review from romac

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rnbguy @romac @adizere