jekyll icon indicating copy to clipboard operation
jekyll copied to clipboard

Jekyll Build failure due to htmlproofer 4.2.0 | Error

Open anisa-hawes opened this issue 2 years ago • 5 comments

I am opening this Issue to signal that our Pull Requests pipeline is blocked, due to a build failure that is caused by an htmlproofer 4.2.0 error.

Clicking in to the error, the following information is provided:

Run chabad360/htmlproofer@master
/usr/bin/docker run --name chabad360htmlproofer_4dd77a --label 4cd98f --workdir /github/workspace --rm -e INPUT_DIRECTORY -e INPUT_ARGUMENTS -e HOME -e GITHUB_JOB -e GITHUB_REF -e GITHUB_SHA -e GITHUB_REPOSITORY -e GITHUB_REPOSITORY_OWNER -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RETENTION_DAYS -e GITHUB_RUN_ATTEMPT -e GITHUB_ACTOR -e GITHUB_WORKFLOW -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GITHUB_EVENT_NAME -e GITHUB_SERVER_URL -e GITHUB_API_URL -e GITHUB_GRAPHQL_URL -e GITHUB_REF_NAME -e GITHUB_REF_PROTECTED -e GITHUB_REF_TYPE -e GITHUB_WORKSPACE -e GITHUB_ACTION -e GITHUB_EVENT_PATH -e GITHUB_ACTION_REPOSITORY -e GITHUB_ACTION_REF -e GITHUB_PATH -e GITHUB_ENV -e GITHUB_STEP_SUMMARY -e RUNNER_OS -e RUNNER_ARCH -e RUNNER_NAME -e RUNNER_TOOL_CACHE -e RUNNER_TEMP -e RUNNER_WORKSPACE -e ACTIONS_RUNTIME_URL -e ACTIONS_RUNTIME_TOKEN -e ACTIONS_CACHE_URL -e GITHUB_ACTIONS=true -e CI=true --entrypoint "/entrypoint.sh" -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/_temp/_runner_file_commands":"/github/file_commands" -v "/home/runner/work/jekyll/jekyll":"/github/workspace" chabad360/htmlproofer
htmlproofer 4.2.0
htmlproofer 4.2.0 | Error:  Whoops, we can't understand your command.
htmlproofer 4.2.0 | Error:  invalid option: --alt-ignore
htmlproofer 4.2.0 | Error:  Run your command again with the --help switch to see available options.

Screenshot 2022-07-22 at 16 29 20

See: PRs #2606, #2624, #2628 and #2632.

At first, I wondered if this error might be linked to our recent updates of figure.html in #2615 and started reading posts like this to try and understand what might be happening, while noticing that subsequent PRs had built successfully....

In dialogue with @hawc2 (who has carried out a couple of local tests) we think that this may be a GitHub Actions Error unrelated to the argument --alt-ignore in build.sh.

For now, I'm stuck here. Does anyone have expertise they could share?

anisa-hawes avatar Jul 22 '22 18:07 anisa-hawes

I saw this error yesterday in another PR and it was the first time - I can't be of any help but if someone from the @programminghistorian/french-team has a clue (@datalogism maybe?), please share.

spapastamkou avatar Jul 22 '22 18:07 spapastamkou

If we can't figure it out soon, should we just revert the figure.html file so we can keep publishing lessons? We can reintegrate the alt-text feature later

hawc2 avatar Jul 22 '22 18:07 hawc2

The thing is that subsequent PRs have built successfully – I had understood from our last conversation that you think this is a GitHub Actions Error unrelated to the arguments in build.sh @hawc2?

anisa-hawes avatar Jul 22 '22 18:07 anisa-hawes

@scottkleinman has replied to me via Slack, to explain that he's recently run into similar problems (outside Jekyll). Recent changes to the way GitHub Actions handles caching might be the cause. He suggests investigating caching-related issues in the htmlproofer repo. I will follow this up next week. (Thank you, Scott 🙂)

anisa-hawes avatar Jul 22 '22 18:07 anisa-hawes

Annotating here that @ZoeLeBlanc has found a temporary solution to this Issue, which she outlines here. We are implementing this temporary fix in PR #2634.

anisa-hawes avatar Jul 24 '22 11:07 anisa-hawes

I've come up against another example of a PR failing because of htmlproofer 3.17.4 | Error: HTML-Proofer found 3 failures PR #2693.

Noting here that a group of us are connecting next Thursday 13th October to talk through a more robust solution to this Issue.

anisa-hawes avatar Oct 05 '22 15:10 anisa-hawes

It looks like it's related to an external link from some old lesson that no longer works. How are we supposed to proceed with publishing lessons when this throws an error for every new pull request @ZoeLeBlanc ?

hawc2 avatar Oct 05 '22 18:10 hawc2

That's a great question @hawc2 ! As far as I can tell, this is not an issue with HTMLProofer. It just seems to be working as we want it to, so a bit confused about this message. I thought we just fixed these links as best as possible and moved forward. Am I missing something @anisa-hawes?

ZoeLeBlanc avatar Oct 05 '22 19:10 ZoeLeBlanc

So sorry @ZoeLeBlanc! I was confused by that error, and thought it was an html-proofer issue, but you are right: it is a simple broken link and I've fixed it in the way I usually do.

anisa-hawes avatar Oct 05 '22 19:10 anisa-hawes

Ok, that makes sense. But it would be ideal if a single broken link didn't break the build for the whole site, right?

hawc2 avatar Oct 05 '22 20:10 hawc2

That's how it is! The build checks involve checking all external and internal links across our site. And in a way it's very helpful, because it helps us to identify problems wherever they arise, in places we wouldn't have checked otherwise.

anisa-hawes avatar Oct 05 '22 20:10 anisa-hawes

The build.yml file and the build.sh include arguments for alt-text ignore, and that error message is appearing at the Github actions stage. I don't see what other than the change in figure.html could've happened to cause this error, and it may relate to conflicting build directions. But altering the build.yml and build.sh to exclude certain commands hasn't fixed it either.

Just noting that as far as I can tell, the site is building fine, it's just the Github actions workflow that is throwing a slight error alerting us the htmlproofer is struggling to ignore empty alt text tags.

On Fri, 22 Jul 2022 at 14:28, Anisa Hawes @.***> wrote:

The thing is that subsequent PRs have built successfully – I had understood from our last conversation that you think this is a GitHub Actions Error unrelated to the arguments in build.sh https://github.com/programminghistorian/jekyll/blob/gh-pages/_build/build.sh @hawc2 https://github.com/hawc2?

— Reply to this email directly, view it on GitHub https://github.com/programminghistorian/jekyll/issues/2633#issuecomment-1192834112, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADXF4EHCFRFRUHOXVZLXFTDVVLR4JANCNFSM54MLCKVA . You are receiving this because you were mentioned.Message ID: @.***>

--

*Alex Wermer-Colan, PhD *

Temple University, Scholars Studio

hawc2 avatar Oct 11 '22 07:10 hawc2

Closing this because we will discuss next steps with htmlproofer in #2738

ZoeLeBlanc avatar Nov 10 '22 15:11 ZoeLeBlanc