backstage-entity-validator/README.md

Backstage entity validator WoodpeckerCI Plugin

A Woodpecker CI plugin for backstage-entity-validator to lint markdown files.
Also usable with Gitlab, Github or locally, see examples for usage.

Example

Woodpecker:

steps:
  backstage-entity-validator:
    image: kokuwaio/backstage-entity-validator
    when:
      event: pull_request
      paths: [catalog-info.yaml]

Gitlab:

backstage-entity-validator:
  stage: lint
  image: kokuwaio/backstage-entity-validator
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
      changes: [catalog-info.yaml]

CLI:

docker run --rm --volume=$(pwd):$(pwd):ro --workdir=$(pwd) kokuwaio/backstage-entity-validator

Settings

Settings Name	Environment	Default	Description
files	PLUGIN_FILES	catalog-info.yaml	Files to validate.