Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

html-proofer: Remove error-sort flag to restore error verbosity #47

Merged
merged 1 commit into from
Feb 15, 2022
Merged

html-proofer: Remove error-sort flag to restore error verbosity #47

merged 1 commit into from
Feb 15, 2022

Conversation

jwflory
Copy link
Contributor

@jwflory jwflory commented Feb 1, 2021

Checklist

  • All new jobs, commands, executors, parameters have descriptions
  • Examples have been added for any significant new features
  • README has been updated, if necessary

Motivation, issues

This commit removes the error-sort flag from the htmlproofer command
in order to restore logs from HTML Proofer in the Circle CI build
report.

The current behavior with this flag added is to suppress all error
messages, which is not helpful when you have a failing CI pipeline from
HTML Proofer. To debug requires a local checkout of the repo and to
manually run HTML Proofer to see the errors.

Description

I tested this change locally and verified that removing this flag
restores the errors in log 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 removing it, thus simplifying what
needs to be maintained here.

@jwflory
Copy link
Contributor Author

jwflory commented Feb 1, 2021

Here is an example from my build pipeline, where htmlproofer reports 583 failures but didn't tell me what the root problem was (I needed to ignore internal cross-links from being checked, a feature I needed from #45):

https://app.circleci.com/pipelines/github/unicef/inventory/8/workflows/e76af7d9-1de4-471d-b8a2-31d3a3f50bf4/jobs/9

@jwflory jwflory force-pushed the change/verbose-htmlproofer branch from e75cabd to af35614 Compare November 6, 2021 20:48
jwflory added a commit to unicef/hugo-orb that referenced this pull request Nov 22, 2021
@jwflory
Address feedback from @dsayling and @gmemstr in PR CircleCI-Public#47
2ce2d29 
* `error-sort` is by default set to an empty string
* `--error-sort` is only invoked in the run step if a parameter is
  passed; otherwise, it is omitted

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
@jwflory
🪲 html-proofer: Adjust error-sort flag for better error verbosity
99c75f8 
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]>
@jwflory jwflory force-pushed the change/verbose-htmlproofer branch from 2ce2d29 to 99c75f8 Compare November 22, 2021 00:55
@jwflory
Copy link
Contributor Author

jwflory commented Nov 22, 2021

Hi @dsayling and @gmemstr, apologies for the late follow-up here. But I implemented the suggested change in commit 2ce2d29, and I believe this is ready for final review. Could you please take a look? Thank you!

@jwflory jwflory mentioned this pull request Nov 22, 2021
Closed
@dsayling
Copy link
Contributor

@jwflory - I'm no longer a maintainer here. @FelicianoTech, @KyleTryon

@jwflory
Copy link
Contributor Author

jwflory commented Feb 14, 2022

Hi @FelicianoTech and @KyleTryon, any chance you can help this move forward? Without this change, HTMLProofer prints no logs in CircleCI and makes it very hard to debug for people on our team who are not Hugo-savvy.

@FelicianoTech FelicianoTech merged commit 23206ae into CircleCI-Public:master Feb 15, 2022
FelicianoTech added a commit that referenced this pull request Feb 15, 2022
@FelicianoTech
Fix Hugo versions and release [semver:minor]
3030428 
This is to fix the older Hugo versions that is causing the int tests to
fail. Then, the minor release is to release the code from the last two
PRs merged: #47 and #48
FelicianoTech added a commit that referenced this pull request Feb 15, 2022
@FelicianoTech
Fix Hugo versions and release [semver:minor]
2656f95 
This is to fix the older Hugo versions that is causing the int tests to
fail. Then, the minor release is to release the code from the last two
PRs merged: #47 and #48
@FelicianoTech FelicianoTech mentioned this pull request Feb 15, 2022
Merged
@jwflory jwflory deleted the change/verbose-htmlproofer branch February 15, 2022 10:53
FelicianoTech added a commit that referenced this pull request Feb 15, 2022
@FelicianoTech
Fix Hugo versions and release [semver:minor] (#50)
b9f4052 
This is to fix the older Hugo versions that is causing the int tests to
fail. Then, the minor release is to release the code from the last two
PRs merged: #47 and #48
jwflory added a commit to sustainers/design that referenced this pull request Feb 15, 2022
@jwflory
⚗️ 🔧 ci: Use verbose HTML-Proofer error messages in logs
5198223 
This commit updates the CircleCI Hugo orb to v1.3.0. This change
incorporates changes I made upstream in the Hugo orb so HTML-Proofer
will print verbose error messages if there is a failure. Currently,
error messages are suppressed in the CircleCI logs and this makes
debugging difficult. Additionally, the `asciidoc` binary is now included
in the container image used in this build, so specifying the Asciidoc
parameter in the CircleCI config is no longer necessary.

Related GitHub Pull Requests:

* CircleCI-Public/hugo-orb#47
* CircleCI-Public/hugo-orb#48
* CircleCI-Public/hugo-orb#50

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
This was referenced Feb 15, 2022
Open
Open
jwflory added a commit to unicef/ooi-toolkit-software that referenced this pull request Feb 15, 2022
@jwflory
⚗️ 🔧 ci: Use verbose HTML-Proofer error messages in logs
6bc6c91 
This commit updates the CircleCI Hugo orb to v1.3.0. This change
incorporates changes I made upstream in the Hugo orb so HTML-Proofer
will print verbose error messages if there is a failure. Currently,
error messages are suppressed in the CircleCI logs and this makes
debugging difficult. Additionally, the `asciidoc` binary is now included
in the container image used in this build, so specifying the Asciidoc
parameter in the CircleCI config is no longer necessary.

Related GitHub Pull Requests:

* CircleCI-Public/hugo-orb#47
* CircleCI-Public/hugo-orb#48
* CircleCI-Public/hugo-orb#50

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
jwflory added a commit to unicef/inventory-hugo-theme that referenced this pull request Feb 15, 2022
@jwflory
⚗️ 🔧 ci: Use verbose HTML-Proofer error messages in logs
32b6adc 
This commit updates the CircleCI Hugo orb to v1.3.0. This change
incorporates changes I made upstream in the Hugo orb so HTML-Proofer
will print verbose error messages if there is a failure. Currently,
error messages are suppressed in the CircleCI logs and this makes
debugging difficult. Additionally, the `asciidoc` binary is now included
in the container image used in this build, so specifying the Asciidoc
parameter in the CircleCI config is no longer necessary.

Related GitHub Pull Requests:

* CircleCI-Public/hugo-orb#47
* CircleCI-Public/hugo-orb#48
* CircleCI-Public/hugo-orb#50

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
jwflory added a commit to unicef/inventory that referenced this pull request Feb 15, 2022
@jwflory
⚗️ 🔧 ci: Use verbose HTML-Proofer error messages in logs
06fd19f 
This commit updates the CircleCI Hugo orb to v1.3.0. This change
incorporates changes I made upstream in the Hugo orb so HTML-Proofer
will print verbose error messages if there is a failure. Currently,
error messages are suppressed in the CircleCI logs and this makes
debugging difficult. Additionally, the `asciidoc` binary is now included
in the container image used in this build, so specifying the Asciidoc
parameter in the CircleCI config is no longer necessary.

Related GitHub Pull Requests:

* CircleCI-Public/hugo-orb#47
* CircleCI-Public/hugo-orb#48
* CircleCI-Public/hugo-orb#50

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
jwflory added a commit to unicef/drone-4sdgtoolkit that referenced this pull request Feb 15, 2022
@jwflory
⚗️ 🔧 ci: Use verbose HTML-Proofer error messages in logs
e4af807 
This commit updates the CircleCI Hugo orb to v1.3.0. This change
incorporates changes I made upstream in the Hugo orb so HTML-Proofer
will print verbose error messages if there is a failure. Currently,
error messages are suppressed in the CircleCI logs and this makes
debugging difficult. Additionally, the `asciidoc` binary is now included
in the container image used in this build, so specifying the Asciidoc
parameter in the CircleCI config is no longer necessary.

Related GitHub Pull Requests:

* CircleCI-Public/hugo-orb#47
* CircleCI-Public/hugo-orb#48
* CircleCI-Public/hugo-orb#50

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
jwflory added a commit to unicef/coach that referenced this pull request Feb 15, 2022
@jwflory
⚗️ 🔧 ci: Use verbose HTML-Proofer error messages in logs
2322dad 
This commit updates the CircleCI Hugo orb to v1.3.0. This change
incorporates changes I made upstream in the Hugo orb so HTML-Proofer
will print verbose error messages if there is a failure. Currently,
error messages are suppressed in the CircleCI logs and this makes
debugging difficult. Additionally, the `asciidoc` binary is now included
in the container image used in this build, so specifying the Asciidoc
parameter in the CircleCI config is no longer necessary.

Related GitHub Pull Requests:

* CircleCI-Public/hugo-orb#47
* CircleCI-Public/hugo-orb#48
* CircleCI-Public/hugo-orb#50

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
This was referenced Feb 15, 2022
Closed
Open
Closed
Open
jwflory added a commit to sustainers/design that referenced this pull request Mar 10, 2022
@jwflory
⚗️ 🔧 ci: Use verbose HTML-Proofer error messages in logs
83f9e60 
This commit updates the CircleCI Hugo orb to v1.3.0. This change
incorporates changes I made upstream in the Hugo orb so HTML-Proofer
will print verbose error messages if there is a failure. Currently,
error messages are suppressed in the CircleCI logs and this makes
debugging difficult. Additionally, the `asciidoc` binary is now included
in the container image used in this build, so specifying the Asciidoc
parameter in the CircleCI config is no longer necessary.

Related GitHub Pull Requests:

* CircleCI-Public/hugo-orb#47
* CircleCI-Public/hugo-orb#48
* CircleCI-Public/hugo-orb#50

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
jwflory added a commit to unicef/coach that referenced this pull request Mar 11, 2022
@jwflory
🆕 🎉 First launch of UNICEF Coach Cards for O.S. Mentorship
a471246 
This commit converts this conceptual repository into a prototype
project. This uses the Hugo static site generator to create a quick
website for evaluating and rating the performance of UNICEF portfolio
companies in a report card-like setting. It uses the UNICEF Inventory
Hugo theme to accomplish this.

Related to #1.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

:bug: :wrench: ci: Fix Shellcheck warnings in deploy script

Warnings identified by @iperdomo in PR #2.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

:alembic: :wrench: ci: Use verbose HTML-Proofer error messages in logs

This commit updates the CircleCI Hugo orb to v1.3.0. This change
incorporates changes I made upstream in the Hugo orb so HTML-Proofer
will print verbose error messages if there is a failure. Currently,
error messages are suppressed in the CircleCI logs and this makes
debugging difficult. Additionally, the `asciidoc` binary is now included
in the container image used in this build, so specifying the Asciidoc
parameter in the CircleCI config is no longer necessary.

Related GitHub Pull Requests:

* CircleCI-Public/hugo-orb#47
* CircleCI-Public/hugo-orb#48
* CircleCI-Public/hugo-orb#50

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
jwflory added a commit to unicef/coach that referenced this pull request Mar 11, 2022
@jwflory
🆕 🎉 First launch of UNICEF Coach Cards for O.S. Mentorship (#2)
6bb58b6 
This commit converts this conceptual repository into a prototype
project. This uses the Hugo static site generator to create a quick
website for evaluating and rating the performance of UNICEF portfolio
companies in a report card-like setting. It uses the UNICEF Inventory
Hugo theme to accomplish this.

Related to #1.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

:bug: :wrench: ci: Fix Shellcheck warnings in deploy script

Warnings identified by @iperdomo in PR #2.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

:alembic: :wrench: ci: Use verbose HTML-Proofer error messages in logs

This commit updates the CircleCI Hugo orb to v1.3.0. This change
incorporates changes I made upstream in the Hugo orb so HTML-Proofer
will print verbose error messages if there is a failure. Currently,
error messages are suppressed in the CircleCI logs and this makes
debugging difficult. Additionally, the `asciidoc` binary is now included
in the container image used in this build, so specifying the Asciidoc
parameter in the CircleCI config is no longer necessary.

Related GitHub Pull Requests:

* CircleCI-Public/hugo-orb#47
* CircleCI-Public/hugo-orb#48
* CircleCI-Public/hugo-orb#50

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
jwflory added a commit to unicef/inventory-hugo-theme that referenced this pull request Mar 11, 2022
@jwflory
⚗️ 🔧 ci: Use verbose HTML-Proofer error messages in logs
e8102ee 
This commit updates the CircleCI Hugo orb to v1.3.0. This change
incorporates changes I made upstream in the Hugo orb so HTML-Proofer
will print verbose error messages if there is a failure. Currently,
error messages are suppressed in the CircleCI logs and this makes
debugging difficult. Additionally, the `asciidoc` binary is now included
in the container image used in this build, so specifying the Asciidoc
parameter in the CircleCI config is no longer necessary.

Related GitHub Pull Requests:

* CircleCI-Public/hugo-orb#47
* CircleCI-Public/hugo-orb#48
* CircleCI-Public/hugo-orb#50

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
jwflory added a commit to unicef/inventory-hugo-theme that referenced this pull request Jun 22, 2022
@jwflory
⚗️ 🔧 ci: Use verbose HTML-Proofer error messages in logs
0818e63 
This commit updates the CircleCI Hugo orb to v1.3.0. This change
incorporates changes I made upstream in the Hugo orb so HTML-Proofer
will print verbose error messages if there is a failure. Currently,
error messages are suppressed in the CircleCI logs and this makes
debugging difficult. Additionally, the `asciidoc` binary is now included
in the container image used in this build, so specifying the Asciidoc
parameter in the CircleCI config is no longer necessary.

Related GitHub Pull Requests:

* CircleCI-Public/hugo-orb#47
* CircleCI-Public/hugo-orb#48
* CircleCI-Public/hugo-orb#50

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
jwflory added a commit to unicef/inventory that referenced this pull request Aug 19, 2022
@jwflory
⚗️ 🔧 ci: Use verbose HTML-Proofer error messages in logs
7dbd448 
This commit updates the CircleCI Hugo orb to v1.3.0. This change
incorporates changes I made upstream in the Hugo orb so HTML-Proofer
will print verbose error messages if there is a failure. Currently,
error messages are suppressed in the CircleCI logs and this makes
debugging difficult. Additionally, the `asciidoc` binary is now included
in the container image used in this build, so specifying the Asciidoc
parameter in the CircleCI config is no longer necessary.

Related GitHub Pull Requests:

* CircleCI-Public/hugo-orb#47
* CircleCI-Public/hugo-orb#48
* CircleCI-Public/hugo-orb#50

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gmemstr gmemstr gmemstr left review comments

@dsayling dsayling dsayling requested changes

@FelicianoTech FelicianoTech FelicianoTech approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jwflory @dsayling @gmemstr @FelicianoTech