Giters

gjtorikian / html-proofer

Test your rendered HTML files to make sure they're accurate.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Official HTMLProofer Docker image

antoniovazquezblanco opened this issue · comments

commented

Lately I've been trying to improve some CI processes over at KiCad. I would like to congratulate all the contributors to this project as it is extremely useful both for the KiCad project and for me personally as well as for many other people and projects.

While working on KiCad websites CI I decided to use HTMLProofer. My preferred way would be to use a previously generated image and let it run...

Unfortunatelly, and for a good reason, at KiCad, some people prefer not to run Docker images not officially maintained by a project. See
https://gitlab.com/kicad/libraries/klc/-/merge_requests/8#note_784838991.

When browsing this repo, in the readme I found the following:
If you have trouble with (or don't want to) install Ruby/Nokogumbo, the command-line tool can be run through Docker. See https://hub.docker.com/r/klakegg/html-proofer for more information.

As the recomendation is similar to the one made by the Hugo project I fear that the response at KiCad will be the same and I deem more reasonable to contribute to a Docker image here at HTMLProofer rather than at KiCad for reusability among other reasons.

I was wondering if there is any plan to incorporate an official Docker image maintained by the HTMLProofer project for people that may be in our same situation or if this not on the roadmap.

Thanks for the awesome project!

commented

I'm sorry to say there's only one maintainer of this project (hello!), and I don't really have the time or inclination to maintain a Docker image. In my humble opinion it should be fine to use the Docker image I've "blessed," or, because of the nature of Docker, the KiCad team can also create their own image based on Ruby and gem install html-proofer themselves. Good luck!

commented

Thank you @gjtorikian for the prompt response and let me congratulate you again for the awesome tool.

For the time being I think we will probably build and host our own images. In the future, if the project keeps growing and you feel like maybe publishing official images I am sure that there will be collaborators such as me willing to contribute.

Keep it up! :)