Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cyb3r-jak3/html5validator-docker

A Docker image for HTML and CSS validation.
https://github.com/cyb3r-jak3/html5validator-docker

docker docker-container docker-image dockerfile gitlab-ci gitlab-pipelines html5validator

Last synced: about 1 month ago
JSON representation

A Docker image for HTML and CSS validation.

Host: GitHub
URL: https://github.com/cyb3r-jak3/html5validator-docker
Owner: Cyb3r-Jak3
License: lgpl-3.0
Created: 2019-10-10T18:28:37.000Z (about 5 years ago)
Default Branch: main
Last Pushed: 2024-02-14T23:34:14.000Z (11 months ago)
Last Synced: 2024-02-15T04:29:31.914Z (10 months ago)
Topics: docker, docker-container, docker-image, dockerfile, gitlab-ci, gitlab-pipelines, html5validator
Language: HCL
Homepage: https://hub.docker.com/r/cyb3rjak3/html5validator
Size: 229 KB
Stars: 4
Watchers: 2
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.MD
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# HTML5Validator

[![Docker Pulls](https://img.shields.io/docker/pulls/cyb3rjak3/html5validator)](https://hub.docker.com/r/cyb3rjak3/html5validator)

[![Publish](https://github.com/Cyb3r-Jak3/html5validator-docker/actions/workflows/publish.yml/badge.svg)](https://github.com/Cyb3r-Jak3/html5validator-docker/actions/workflows/publish.yml) [![Test Build](https://github.com/Cyb3r-Jak3/html5validator-docker/actions/workflows/test_build.yml/badge.svg)](https://github.com/Cyb3r-Jak3/html5validator-docker/actions/workflows/test_build.yml)

This is a docker image made to test HTML code. I developed it for [my website](https://www.jwhite.network) using GitLab pipelines. This will work for any sort of pipeline solution. It setups up a container that has [html5validator](https://github.com/svenkreiss/html5validator) installed, which saves time with the testing process.

There are images available through GitHub, Docker Hub or GitLab.

## To use

First figure out the version you want then checkout out the [source](#sources)

### GitLab Pipeline

Using the source of your choosing you will want something like:

```yaml
html_test:
stage: test
image: cyb3rjak3/html5validator:latest-alpine
script:
- html5validator --root public/ --also-check-css --log INFO
```

Which is used by this [project](.gitlab-ci.yml)

### GitHub Action

For GitHub Actions, please use the action that I have built here: [HTML5 Validator](https://github.com/marketplace/actions/html5-validator)
The action is built using this image

[Source Repo](https://github.com/Cyb3r-Jak3/html5validator-action)

### Local

```bash
# Pull the image of your choosing. Only has to be done once
docker pull cyb3rjak3/html5validator:latest-alpine

# If your code is in a relative directory called `public`
docker run --rm -i -v $(pwd):/mnt -w /mnt cyb3rjak3/html5validator:latest-alpine html5validator --root public
```

## Sources

You can pull the image from either Docker Hub, GitHub, or GitLab. Currently the default images are based off of `python:3.9-alpine` there are images available using `python:3.9-slim`.

To use the slim based images add `-slim` to the tag you are using, i.e. `cyb3rjak3/html5validator:latest` becomes `cyb3rjak3/html5validator:latest-slim`.

| | [Docker](https://hub.docker.com/r/cyb3rjak3/html5validator) | [GitHub](https://github.com/Cyb3r-Jak3/html5validator-docker/pkgs/container/html5validator) | [Gitlab](https://gitlab.com/Cyb3r-Jak3/html5validator-docker/container_registry/1945095) |
|--------------|-------------------------------------------------------------|---------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
| pypi | cyb3rjak3/html5validator:pypi | ghcr.io/cyb3rjak3/html5validator:pypi | registry.gitlab.com/cyb3r-jak3/html5validator-docker:pypi |
| source | cyb3rjak3/html5validator:source | ghcr.io/cyb3rjak3/html5validator:source | registry.gitlab.com/cyb3r-jak3/html5validator-docker:source |
| experimental | cyb3rjak3/html5validator:experimental | ghcr.io/cyb3rjak3/html5validator:experimental | registry.gitlab.com/cyb3r-jak3/html5validator-docker:experimental |

## Tags

There are currently three tags for this image: `source`, `pypi`, and `experimental`. The source tag involves building html5validator from [source](https://github.com/svenkreiss/html5validator), the PyPI installs the packaged version, and the experimental branch builds from my fork of [html5validator](https://github.com/Cyb3r-Jak3/html5validator). The PyPi tag is more stable than the source branch, thus it is the latest tag.