Skip to content

dracor-org/tei-validate-action

Repository files navigation

tei-validate-action

This GitHub action validates TEI files specified by the tei-files input against the TEI_all schema.

Inputs

tei-version

The TEI version to validate against. Default "4.7.0".

Supported versions are 4.0.0, 4.1.0, 4.2.0, 4.2.1, 4.2.2, 4.3.0, 4.4.0, 4.5.0, 4.6.0 and 4.7.0.

tei-files

Path or pattern pointing to TEI files to validate. Default "tei/*.xml"

Example usage

jobs:
  validate_tei:
    runs-on: ubuntu-latest
    name: Validate TEI documents against TEI_all schema
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Validate
        uses: dracor-org/tei-validate-action@v1.2.0
        with:
          tei-version: '4.2.2'

Testing locally

With docker installed this action can also be run locally. You need to mount your local TEI files to the /tei directory in the docker container:

docker pull dracor/tei-validate-action:latest
docker run --rm -it -v /path/to/local/tei/dir:/tei dracor/tei-validate-action

This validates each XML file in the /tei directory against the latest supported TEI version.

To validate against a different TEI version and/or to validate only specific files you can pass the version number and a file pattern as input arguments:

docker run --rm -it -v /path/to/local/tei/dir:/tei \
  dracor/tei-validate-action \
  '4.2.2' \
  'tei/lessing-*.xml'