Skip to content

Commit

Permalink
Merge pull request #332 from SpineEventEngine/disable-links-checks-fo…
Browse files Browse the repository at this point in the history
…r-git-hub

Add ignore rule for external GitHub links to the links checker command.
  • Loading branch information
andreySadomovskiy authored Jul 14, 2020
2 parents 5673bc3 + 64f31fa commit d892672
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/links-check.yml
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
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.

0 comments on commit d892672

Please sign in to comment.