Skip to content

Commit

Permalink
🪲 html-proofer: Adjust error-sort flag for better error verbosity
Browse files Browse the repository at this point in the history
This commit changes the `error-sort` flag to use an empty parameter in
the `html-proofer` command. This causes HTML-Proofer to show specific
error messages in CircleCI build logs, where the current behavior is to
suppress error messages.

The current default behavior makes it difficult to debug errors from
HTML-Proofer in a failing CI pipeline. Debugging requires clone the
repository and running HTML-Proofer locally to see error messages.

This is an uncommon flag to use for HTML-Proofer, and I think it does
not do exactly what it is expected to do, so the best option appears to
be setting the parameter as blank.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
  • Loading branch information
jwflory committed Nov 22, 2021
1 parent 1afef1b commit 99c75f8
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/commands/html-proofer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ parameters:
type: boolean
default: true
error-sort:
description: "Defines the sort order for error output. Can be `:path`, `:desc`, or `:status` (default: `:path`)."
description: "Defines the sort order for error output. Can be `:path`, `:desc`, or `:status`."
type: string
default: ':path'
default: "''"
enforce-https:
description: "Fails a link if it's not marked as `https` (default: `false`)."
type: boolean
Expand Down Expand Up @@ -167,7 +167,7 @@ steps:
--directory-index-file << parameters.directory-index-file >> \
<<# parameters.disable-external >> --disable-external <</ parameters.disable-external >> \
<<# parameters.empty-alt-ignore >> --empty-alt-ignore <</ parameters.empty-alt-ignore >> \
--error-sort << parameters.error-sort >> \
<<# parameters.error-sort >>--error-sort << parameters.error-sort >> <</ parameters.error-sort >> \
<<# parameters.enforce-https >> --enforce-https <</ parameters.enforce-https >> \
--extension << parameters.extension >> \
<<# parameters.external_only >> --external_only <</ parameters.external_only >> \
Expand Down

0 comments on commit 99c75f8

Please sign in to comment.