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

feat: add markdown links checker #43

Merged
merged 11 commits into from
Sep 27, 2021

Conversation

jaybxyz
Copy link
Contributor

@jaybxyz jaybxyz commented Sep 24, 2021

Description

This PR adds markdown link checker workflow to check all Markdown files for broken links every 24 hours.

closes: #41

Tasks

  • Add linkchecker.yml
  • Fix broken links

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Appropriate labels applied
  • Targeted PR against correct branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

@jaybxyz jaybxyz self-assigned this Sep 24, 2021
@codecov
Copy link

codecov bot commented Sep 24, 2021

Codecov Report

Merging #43 (4e31b03) into master (e21abdf) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #43   +/-   ##
=======================================
  Coverage   79.85%   79.85%           
=======================================
  Files          12       12           
  Lines         283      283           
=======================================
  Hits          226      226           
  Misses         42       42           
  Partials       15       15           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e21abdf...4e31b03. Read the comment docs.

@jaybxyz jaybxyz marked this pull request as ready for review September 24, 2021 07:30
@jaybxyz
Copy link
Contributor Author

jaybxyz commented Sep 24, 2021

Just realized that this PR is not up to date. So I just merged with the latest master branch.

Copy link
Contributor

@dongsam dongsam left a comment

Choose a reason for hiding this comment

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

I don't think linkchecker is working at the moment in workflow, so I think we need to merge after checking that it is working by adding a broken link for testing.

.github/workflows/linkchecker.yml Outdated Show resolved Hide resolved
@jaybxyz
Copy link
Contributor Author

jaybxyz commented Sep 24, 2021

I reference Cosmos SDK's linkchecker.yml, and they seem to use scheduled runs to check links regularly in addition to checking links on every push or pull requests.

Copy link
Contributor

@dongsam dongsam left a comment

Choose a reason for hiding this comment

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

LGTM!

@jaybxyz jaybxyz merged commit b1fd562 into tendermint:master Sep 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add markdown link check on workflow
2 participants