athackst/HTMLProofer Action
Run HTMLProofer through the Ruby gem API with broad option support, retries, and cache-friendly defaults.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| directory | The directory to scan | yes | ./_site |
| allow_hash_href | Whether `href="#"` anchors are valid | no | — |
| allow_missing_href | Do not flag a tags missing href | no | — |
| assume_extension | Automatically add extension (e.g. .html) to file paths, to allow extensionless URLs (as supported by Jekyll 3 and GitHub Pages) | no | — |
| check_favicon | Check whether favicons are valid | no | — |
| check_links | Check whether 'a', 'link' elements are working | no | — |
| check_images | Check whether 'img' elements are working | no | — |
| check_scripts | Check whether 'script' elements are working | no | — |
| check_opengraph | Check images and URLs in Open Graph metadata | no | — |
| check_external_hash | Check whether external anchors exist | no | — |
| check_internal_hash | Checks whether internal hashes exist (even if the webpage exists) | — | — |
| check_sri | Check that `<link>` and `<script>` external resources use SRI | no | — |
| directory_index_file | Sets the file to look for when a link refers to a directory. | no | — |
| disable_external | If `true`, does not run the external link checker | no | — |
| enforce_https | Require that links use HTTPS | no | — |
| extensions | A list of Strings indicating the file extensions you would like to check (including the dot) | no | — |
| ignore_empty_alt | If `true`, ignores images with empty/missing alt tags | no | — |
| ignore_files | A list (new line or comma separated) list of regex or strings containing file paths that are safe to ignore | no | — |
| ignore_empty_mailto | If `true`, allows `mailto:` `href`s which do not contain an email address. | no | — |
| ignore_missing_alt | If `true`, ignores images with missing alt tags | no | — |
| ignore_status_codes | A list of numbers representing status codes to ignore. | no | — |
| ignore_urls | A list (new line or comma separated) of Strings or RegExps containing URLs that are safe to ignore. | no | https://fonts.gstatic.com |
| ignore_new_files | Whether to ignore files that are new | no | false |
| swap_urls | Newline-separated list of regex expressions to swap in urls | no | — |
| host | The host URL of your site | no | ${{ github.repository_owner }}.github.io |
| base_path | The base path of your site | no | /${{ github.event.repository.name }} |
| max_concurrency | Maximum number of concurrent requests | no | — |
| connect_timeout | HTTP connection timeout | no | — |
| followlocation | If 'true' will follow redirections | no | — |
| ssl_verifypeer | If you’re hitting a non-verifiable SSL server then you’ll have to disable peer verification to make SSL work | no | — |
| ssl_verifyhost | If you are getting `SSL: certificate subject name does not match target host name` from curl | no | — |
| timeout | HTTP request timeout | no | — |
| retries | Number of times to retry checking links | no | 6 |
| cache | JSON configuration for HTMLProofer caching | no | { "timeframe": { "external": "2w", "internal": "1w" } } |
| gh_token | Github token | no | ${{ github.token }} |
| check_html | Validate HTML | no | — |
| check_img_http | Enforce that images use HTTPS | no | — |
| empty_alt_ignore | Allow images with empty alt tags | no | — |
| missing_alt_ignore | Allow images with missing alt tags | no | — |
| url_ignore | Newline-separated list of URLs to ignore | no | — |
| url_ignore_re | Newline-separated list of URL regexes to ignore | no | — |
| url_swap | Newline-separated list of regex expressions to swap in urls | no | — |
| internal_domains | Newline-separated list of internal domains | no | — |
| max_paralell | Maximum parallel processes | no | — |
Outputs
no outputs