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

GitHub Action

Avrolint Action

v1.0.4 Pre-release

Avrolint Action

play

Avrolint Action

GitHub Action to run linting checks using avro-js

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Avrolint Action

uses: frankgrimes97/avrolint-action@v1.0.4

Learn more about this action in frankgrimes97/avrolint-action

Choose a version

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: ''