diff --git a/README.md b/README.md index cfdfa71..15462cb 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ The action aims at detecting and reporting broken links. ## How to use it? -A set of examples are included in the [examples](examples) folder. A few detailed +A set of examples are included in the [examples](examples) folder. A few detailed examples are also included below. Note that examples always reference the master branch, however you should change them to reference a [release](https://github.com/urlstechie/urlchecker-action/releases). @@ -47,13 +47,13 @@ jobs: # How many times to retry a failed request (each is logged, defaults to 1) retry_count: 3 - # A comma separated links to exclude during URL checks + # A comma-separated list of URLs to exclude from checks exclude_urls: https://github.com/SuperKogito/URLs-checker/issues/1,https://github.com/SuperKogito/URLs-checker/issues/2 - # A comma separated patterns to exclude during URL checks - exclude_patterns: https://github.com/SuperKogito/Voice-based-gender-recognition/issues + # A comma-separated list of substrings to exclude matching URLs from checks + exclude_patterns: localhost:3030,https://github.com/SuperKogito/Voice-based-gender-recognition/issues - # choose if the force pass or not + # Choose if the force pass or not force_pass : true ``` @@ -105,37 +105,37 @@ jobs: # How many times to retry a failed request (each is logged, defaults to 1) retry_count: 3 - # A comma separated links to exclude during URL checks + # A comma-separated list of URLs to exclude from checks exclude_urls: https://github.com/SuperKogito/URLs-checker/issues/1,https://github.com/SuperKogito/URLs-checker/issues/2 - # A comma separated patterns to exclude during URL checks + # A comma-separated list of substrings to exclude matching URLs from checks exclude_patterns: https://github.com/SuperKogito/Voice-based-gender-recognition/issues - # A comma separated list of file patterns (direct paths work as well) to exclude + # A comma-separated list of file paths to exclude from checks (supports regex) exclude_files: README.md,/github/workspace/_config.yml - # choose if the force pass or not + # Choose if the force pass or not force_pass : true ``` ## Inputs -| variable name | variable type | variable description | -|-----------------------------|----------------------------------------------|------------------------------------------------------------------| -| `git_path` | optional | A git url to clone, if the repository isn't already in $PWD | -| `branch` | optional | If we do a clone, clone this branch (defaults to master | -| `cleanup` | optional | If we do a clone, delete the cloned folder after (false) | -| `subfolder` | optional | A subfolder to navigate to in the repository to check | -| `file_types` | optional | A comma-separated list of file types to cover in the URLs checks.| -| `include_files` | optional | A comma-separated list of exact files to check. | -| `print_all` | optional | Choose whether to include file with no URLs in the prints. | -| `retry_count` | optional | If a request fails, retry this number of times. Defaults to 1 | -| `save` | optional | A path to a csv file to save results to | -| `timeout` | optional | The timeout to provide to requests to wait for a response. | -| `exclude_urls` | optional | A comma separated list of links. | -| `exclude_patterns` | optional | A comma separated list of patterns. | -| `exclude_files` | optional | Full paths to files to exclude (comma separated list). | -| `force_pass` | optional | Choose whether to force a pass when checks are done. | +| variable name | variable type | variable description | +|-----------------------------|----------------------------------------------|------------------------------------------------------------------------------------| +| `git_path` | optional | Git URL to clone (if the repository isn't already in `$PWD`) | +| `branch` | optional | Branch to clone (if `git_path` is used, defaults to `master`) | +| `cleanup` | optional | Whether to delete the cloned folder after (defaults to `false`) | +| `subfolder` | optional | Subfolder to navigate to in the repository to check | +| `file_types` | optional | Comma-separated list of file types to check | +| `include_files` | optional | Comma-separated list of files to check (supports regex) | +| `print_all` | optional | Whether to include files with no URLs in the action output (defaults to `true`) | +| `retry_count` | optional | Number of times to retry a request upon failure (defaults to `1`) | +| `save` | optional | File path where `.csv` results are written | +| `timeout` | optional | Request timeout (in seconds) | +| `exclude_urls` | optional | Comma-separated list of URLs to exclude | +| `exclude_patterns` | optional | Comma-separated list of substrings that exclude matching URLs | +| `exclude_files` | optional | Comma-separated list of file paths to exclude (supports regex) | +| `force_pass` | optional | Whether the check should always pass, even with broken links (defaults to `false`) | ## Demo - Using version > 0.1.4