tommy-gilligan / html5validator-action Goto Github PK

View Code? Open in Web Editor NEW

GitHub Action that checks HTML5 syntax.

License: Mozilla Public License 2.0

Shell 82.28% CSS 1.37% HTML 9.51% Dockerfile 6.84%

html5validator-action's Introduction

HTML5 Validator Action

This action checks the syntax of your html files in the path you specify.
It used html5validator and a docker image that I build from it.

For help getting started, check out the wiki.

Inputs

Flag	Description	Default
`root`	The root path of the files you want to check
`config`	Path to config file to use.
`format`	The format for logging. Supported values: `json, xml, gnu, text`.
`log_level`	The log level to use. Supported values: `DEBUG, INFO, WARNING`.	`WARNING`
`css`	Enable to check css. Supported values: `true, false`	`false`
`blacklist`*	The names of files or directories to blacklist. These are not full paths.
`skip_git_check`	Skip checking that the repo has been checked out

Examples of blacklist

Correct Example:

    - name: HTML5Validator
      uses: Cyb3r-Jak3/html5validator-action
      with:
        root: tests/
        blacklist: invalid

Incorrect Example:

    - name: HTML5Validator
      uses: Cyb3r-Jak3/html5validator-action
      with:
        root: tests/
        blacklist: tests/invalid

Outputs

`result`

The exit code of the validation.

Example usage

      uses: Cyb3r-Jak3/[email protected]
      with:
        root: tests/valid/

A log file is automatically created. To retrieve it, use Github's upload artifact action after the validator action.

    - uses: actions/upload-artifact@v3
      with:
        name: log
        path: log.log

Keep up-to-date with GitHub Dependabot

Since Dependabot has native GitHub Actions support, to enable it on your GitHub repo all you need to do is add the .github/dependabot.yml file:

version: 2
updates:
  # Maintain dependencies for GitHub Actions
  - package-ecosystem: "github-actions"
    directory: "/"
    schedule:
      interval: "weekly"

Recommend Projects