frankgrimes97/Avrolint Action

GitHub Action to run linting checks using avro-js

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stalelast commit Mar 31, 2023
License: Apache 2.0
Runtime: Deprecated runtime

Pinned Snippet

workflow.ymlSHA-pinned

uses: frankgrimes97/avrolint-action@7b0efe34adc12848dc81fab15032a5675343f746 # v1.0.5

tags can be moved; commit SHAs can't. why a SHA?

Inputs

name	description	required	default
avsc-to-lint	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"]'	yes	—
undocumented-field-check	Check that all fields are documented.	yes	true
complex-union-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>]	yes	true

Outputs

no outputs