-
Notifications
You must be signed in to change notification settings - Fork 0
/
action.yml
155 lines (153 loc) · 5.1 KB
/
action.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
name: HtmlProofer Action
author: athackst
description: Run HtmlProofer
inputs:
# required inputs
directory:
description: The directory to scan
required: true
default: "./_site"
# optional inputs
allow_hash_href:
description: Whether `href="#"` anchors are valid
required: false
allow_missing_href:
description: Do not flag a tags missing href
required: false
assume_extension:
description: Automatically add extension (e.g. .html) to file paths, to allow extensionless URLs (as supported by Jekyll 3 and GitHub Pages)
required: false
check_favicon:
description: Check whether favicons are valid
required: false
check_links:
description: Check whether 'a', 'link' elements are working
required: false
check_images:
description: Check whether 'img' elements are working
required: false
check_scripts:
description: Check whether 'script' elements are working
required: false
check_opengraph:
description: Check images and URLs in Open Graph metadata
required: false
check_external_hash:
description: Check whether external anchors exist
required: false
check_internal_hash:
description: Checks whether internal hashes exist (even if the webpage exists)
check_sri:
description: Check that `<link>` and `<script>` external resources use SRI
required: false
directory_index_file:
description: Sets the file to look for when a link refers to a directory.
required: false
disable_external:
description: If `true`, does not run the external link checker
required: false
enforce_https:
description: Require that links use HTTPS
required: false
extensions:
description: An array of Strings indicating the file extensions you would like to check (including the dot)
required: false
ignore_empty_alt:
description: If `true`, ignores images with empty/missing alt tags
required: false
ignore_files:
description: Newline-separated list of regex or strings containing file paths that are safe to ignore
required: false
ignore_empty_mailto:
description: If `true`, allows `mailto:` `href`s which do not contain an email address.
required: false
ignore_missing_alt:
description: If `true`, ignores images with missing alt tags
required: false
ignore_status_codes:
description: An array of numbers representing status codes to ignore.
required: false
ignore_urls:
description: Newline-separated list of URLs to ignore. Uses same syntax as htmlproofer.
required: false
default: |
https://fonts.gstatic.com
swap_urls:
description: Newline-separated list of regex expressions to swap in urls
required: false
host:
description: The host URL of your site
required: false
default: ${{ github.repository_owner }}.github.io
base_path:
description: The base name of your site
required: false
default: /${{ github.event.repository.name }}
# Hydra options
max_concurrency:
description: Maximum number of concurrent requests
required: false
# Typhoeus options
connect_timeout:
description: HTTP connection timeout
required: false
followlocation:
description: If 'true' will follow redirections
required: false
ssl_verifypeer:
description: If you’re hitting a non-verifiable SSL server then you’ll have to disable peer verification to make SSL work
required: false
ssl_verifyhost:
description: "If you are getting `SSL: certificate subject name does not match target host name` from curl"
required: false
timeout:
description: HTTP request timeout
required: false
# Other
retries:
description: Number of times to retry checking links
required: false
default: 3
# Deprecated
check_html:
description: Validate HTML
required: false
deprecationMessage: use `check_links`
check_img_http:
description: Enforce that images use HTTPS
required: false
deprecationMessage: use `check_images`
empty_alt_ignore:
description: Allow images with empty alt tags
required: false
deprecationMessage: Use `ignore_empty_alt` instead
missing_alt_ignore:
description: Allow images with missing alt tags
required: false
deprecationMessage: Use `ignore_missing_alt` instead
url_ignore:
description: Newline-separated list of URLs to ignore
required: false
deprecationMessage: Use `ignore_urls` instead
url_ignore_re:
description: Newline-separated list of URL regexes to ignore
required: false
deprecationMessage: Use `ignore_urls` instead
url_swap:
description: Newline-separated list of regex expressions to swap in urls
required: false
deprecationMessage: Use `swap_urls` instead
internal_domains:
description: Newline-separated list of internal domains
required: false
deprecationMessage: Setting `internal_domains` has been deprecated in htmlproofer
max_paralell:
description: Maximum parallel processes
required: false
deprecationMessage: Setting `max_paralell` has been deprecated in htmlproofer
runs:
using: "docker"
image: "Dockerfile"
branding:
icon: link
color: green