Skip to content

Commit cb42fa7

Browse files
author
Scott Hyndman
committed
Unify writing style of action arguments
1 parent 6e6b004 commit cb42fa7

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

‎README.md

+30-30
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The action aims at detecting and reporting broken links.
99

1010
## How to use it?
1111

12-
A set of examples are included in the [examples](examples) folder. A few detailed
12+
A set of examples are included in the [examples](examples) folder. A few detailed
1313
examples are also included below. Note that examples always reference the master branch,
1414
however you should change them to reference a [release](https://github.com/urlstechie/urlchecker-action/releases).
1515

@@ -38,7 +38,7 @@ jobs:
3838
# A comma-separated list of file types to cover in the URL checks
3939
file_types: .md,.py,.rst
4040
41-
# Choose whether to include file with no URLs in the prints.
41+
# Whether to include files without URLs in the action output
4242
print_all: false
4343
4444
# The timeout seconds to provide to requests, defaults to 5 seconds
@@ -47,13 +47,13 @@ jobs:
4747
# How many times to retry a failed request (each is logged, defaults to 1)
4848
retry_count: 3
4949
50-
# A comma separated links to exclude during URL checks
50+
# A comma-separated list of URLs to exclude from checks
5151
exclude_urls: https://github.com/SuperKogito/URLs-checker/issues/1,https://github.com/SuperKogito/URLs-checker/issues/2
5252
53-
# A comma separated patterns to exclude during URL checks
54-
exclude_patterns: https://github.com/SuperKogito/Voice-based-gender-recognition/issues
53+
# A comma-separated list of substrings to exclude matching URLs from checks
54+
exclude_patterns: localhost:3030,https://github.com/SuperKogito/Voice-based-gender-recognition/issues
5555
56-
# choose if the force pass or not
56+
# Whether to force success, even if broken links are found
5757
force_pass : true
5858
```
5959

@@ -90,52 +90,52 @@ jobs:
9090
# A subfolder or path to navigate to in the present or cloned repository
9191
subfolder: docs
9292
93-
# Delete the cloned repository after running URLchecked (default is false)
93+
# Whether to delete the cloned repo after the check (default is `false`)
9494
cleanup: true
9595
9696
# A comma-separated list of file types to cover in the URL checks
9797
file_types: .md,.py,.rst
9898
99-
# Choose whether to include file with no URLs in the prints.
99+
# Whether to include files without URLs in the action output
100100
print_all: false
101101
102-
# The timeout seconds to provide to requests, defaults to 5 seconds
102+
# The timeout seconds to provide to requests (in seconds, defaults to `5`)
103103
timeout: 5
104104
105-
# How many times to retry a failed request (each is logged, defaults to 1)
105+
# How many times to retry a failed request (each is logged, defaults to `1`)
106106
retry_count: 3
107107
108-
# A comma separated links to exclude during URL checks
108+
# A comma-separated list of URLs to exclude from checks
109109
exclude_urls: https://github.com/SuperKogito/URLs-checker/issues/1,https://github.com/SuperKogito/URLs-checker/issues/2
110110
111-
# A comma separated patterns to exclude during URL checks
111+
# A comma-separated list of substrings to exclude matching URLs from checks
112112
exclude_patterns: https://github.com/SuperKogito/Voice-based-gender-recognition/issues
113113
114-
# A comma separated list of file patterns (direct paths work as well) to exclude
114+
# A comma-separated list of file paths to exclude from checks (supports regex)
115115
exclude_files: README.md,/github/workspace/_config.yml
116116
117-
# choose if the force pass or not
117+
# Whether to force success, even if broken links are found
118118
force_pass : true
119119
```
120120
## Inputs
121121

122122

123-
| variable name | variable type | variable description |
124-
|-----------------------------|----------------------------------------------|------------------------------------------------------------------|
125-
| `git_path` | <span style="color:green"> optional </span> | A git url to clone, if the repository isn't already in $PWD |
126-
| `branch` | <span style="color:green"> optional </span> | If we do a clone, clone this branch (defaults to master |
127-
| `cleanup` | <span style="color:green"> optional </span> | If we do a clone, delete the cloned folder after (false) |
128-
| `subfolder` | <span style="color:green"> optional </span> | A subfolder to navigate to in the repository to check |
129-
| `file_types` | <span style="color:green"> optional </span> | A comma-separated list of file types to cover in the URLs checks.|
130-
| `include_files` | <span style="color:green"> optional </span> | A comma-separated list of exact files to check. |
131-
| `print_all` | <span style="color:green"> optional </span> | Choose whether to include file with no URLs in the prints. |
132-
| `retry_count` | <span style="color:green"> optional </span> | If a request fails, retry this number of times. Defaults to 1 |
133-
| `save` | <span style="color:green"> optional </span> | A path to a csv file to save results to |
134-
| `timeout` | <span style="color:green"> optional </span> | The timeout to provide to requests to wait for a response. |
135-
| `exclude_urls` | <span style="color:green"> optional </span> | A comma separated list of links. |
136-
| `exclude_patterns` | <span style="color:green"> optional </span> | A comma separated list of patterns. |
137-
| `exclude_files` | <span style="color:green"> optional </span> | Full paths to files to exclude (comma separated list). |
138-
| `force_pass` | <span style="color:green"> optional </span> | Choose whether to force a pass when checks are done. |
123+
| variable name | variable type | variable description |
124+
|-----------------------------|----------------------------------------------|---------------------------------------------------------------------------------------|
125+
| `git_path` | <span style="color:green"> optional </span> | Git URL to clone (if the repository isn't already in `$PWD`) |
126+
| `branch` | <span style="color:green"> optional </span> | Branch to clone (if `git_path` is used, defaults to `master`) |
127+
| `cleanup` | <span style="color:green"> optional </span> | Whether to delete the cloned repo after the check (defaults to `false`) |
128+
| `subfolder` | <span style="color:green"> optional </span> | Subfolder to navigate to in the repository to check |
129+
| `file_types` | <span style="color:green"> optional </span> | Comma-separated list of file types to check |
130+
| `include_files` | <span style="color:green"> optional </span> | Comma-separated list of files to check (supports regex) |
131+
| `print_all` | <span style="color:green"> optional </span> | Whether to include files without URLs in the action output (defaults to `true`) |
132+
| `retry_count` | <span style="color:green"> optional </span> | Number of times to retry a request upon failure (defaults to `3`) |
133+
| `save` | <span style="color:green"> optional </span> | File path where `.csv` results are written |
134+
| `timeout` | <span style="color:green"> optional </span> | Request timeout (in seconds, defaults to `1`) |
135+
| `exclude_urls` | <span style="color:green"> optional </span> | Comma-separated list of URLs to exclude |
136+
| `exclude_patterns` | <span style="color:green"> optional </span> | Comma-separated list of substrings that exclude matching URLs |
137+
| `exclude_files` | <span style="color:green"> optional </span> | Comma-separated list of file paths to exclude (supports regex) |
138+
| `force_pass` | <span style="color:green"> optional </span> | Whether to force action success, even if broken links are found (defaults to `false`) |
139139

140140
## Demo
141141
- Using version > 0.1.4

0 commit comments

Comments
 (0)