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 ignore rule for external GitHub links to the links checker command. #332

Merged
merged 2 commits into from
Jul 14, 2020
Merged

Add ignore rule for external GitHub links to the links checker command. #332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f7ab5c0
Add ignore external GitHub links to the links checker command.
andreySadomovskiy Jul 14, 2020
64f31fa
Fix readme comment.
andreySadomovskiy Jul 14, 2020
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
2 changes: 1 addition & 1 deletion .github/workflows/links-check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ jobs:
gem install bundler
bundle install
jekyll build
htmlproofer --assume-extension ./_site
htmlproofer --assume-extension ./_site --url-ignore /github\.com/
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ code to Markdown pages. See [this doc](_samples/README.md) for the instructions.

We use the [html-proofer](https://github.com/gjtorikian/html-proofer) tool to test broken links.
To start test locally you may be required to install tool Gem first:
`bundle install` and build site `jekyll build`. After that use `htmlproofer --assume-extension ./_site` command.
`bundle install` and build site `jekyll build`. After that use `htmlproofer --assume-extension ./_site --url-ignore /github\.com/` command.
GitHub links are ignored because of wrong error logging described in [this](https://github.com/gjtorikian/html-proofer/issues/226) issue.

Also, we have the `Links check` GitHub Action for this test. It will start on push to the repository.