Skip to content

Warning

You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?

Avrolint Action

Actions
GitHub Action to run linting checks using avro-js
v1.0.3
Star (3)

Avrolint v1

This action performs linting on Apache Avro Schema files (.avsc).

Usage

- uses: frankgrimes97/avrolint-action@v1
  with:
    # Avro schema file(s) to lint
    # Can be a single file path:
    #   e.g. '/tmp/avroSchema.avsc'
    # Can be a string containing a JSON-encoded array of paths:
    #   e.g. '["/tmp/avroSchemaA.avsc", "/tmp2/avroSchemaB.avsc"]'
    avsc-to-lint: ''

    # Check that all fields are documented.
    # Default: true
    undocumented-field-check: ''

    # Check that union types are all simple types.
    # i.e. only used to express nullability
    # This is enforced because schemas which have complex union types are
    # difficult for most programming language type systems to handle gracefully.
    # e.g.
    #   valid: ["null", <TYPE>]
    #   invalid: [<TYPE1>, <TYPE2>]
    #   invalid: ["null", <TYPE1>, <TYPE2>]
    # Default: true
    complex-union-check: ''

Avrolint Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

GitHub Action to run linting checks using avro-js
v1.0.3

Avrolint Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.