search

pyOpenSci / pyopensci.github.io

This is the website for pyOpenSci. Contributions welcome!!
https://www.pyopensci.org
Other
35 stars 61 forks source link

Fix: update htmlproofer #343

Closed lwasser closed 3 months ago

lwasser commented 3 months ago

i'm trying to now run html proofer via a script to customize how it operates.

lwasser commented 3 months ago

This actually works ✨ but

  1. it's fairly slow taking a few minutes to run even with link caching.
  2. it also fails as it should be doesn't print the failure points into the action results - rather you have to look at the raw logs which is not ideal.

there may be a way to caption that information however in the terminal - it works locally just not in the action. nothing gets written out in the action for some reason.

willingc commented 3 months ago

I like this approach. I will give it a look on Monday re: output.

willingc commented 3 months ago

You may also want to try this action: https://github.com/anishathalye/proof-html

It seems better maintained than what we had and is used by a few thousand folks.

lwasser commented 3 months ago

@willingc thank you i can't figure this out. The approach i implmeneted works well - i've tested it locally in all scenarios. it ignores new files but finds broken links in them. it looks for alt tags and other html issues. but the only way to see the output when it fails it so view the raw logs.

i'm so confused by this because locally the output in the terminal is there. so this is a ci specific issue that i don't yet understand.

that action looks nice but i worry it won't ignore new files similar to the action we have now. i could be wrong!!

lwasser commented 3 months ago

oh it's a totally different tool! we should try that!! writing ruby code is not my favorite things to do 😆 And an pre-built action with a docker container will always be faster

lwasser commented 3 months ago

@willingc actually i just encountered the SAME issue in a pr jesse opened with htmlproofer. so now i'm wondering if we should actually drop htmlproofer. i will open an issue however just in case the maintainer sees it (hasn't been updated since august)

Screenshot 2024-04-01 at 9 37 16 AM
lwasser commented 3 months ago

issue open here

lwasser commented 3 months ago

I am going to merge this just to see how it does - especially knowing we have a new page i can test it on! i will revert if it is too slow / doesn't work as expected.