Skip to content

ai-domain-data/ai-domain-data-validate-action

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AI Domain Data Validate (GitHub Action)

Validate a domain-profile.json file against the AI Domain Data Standard v0.1.1 (backward-compatible with v0.1) using the aidd CLI. Fails the workflow if the file is missing or invalid.

The action validates against the latest schema which includes:

  • Required fields: spec, name, description, website, contact
  • Optional fields: logo, entity_type (schema.org values), jsonld (schema.org JSON-LD blocks)

Usage

name: Validate AI Domain Data

on:
  push:
    branches: [main]
  pull_request:

jobs:
  validate-ai-domain-data:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Validate domain-profile.json
        uses: ai-domain-data/ai-domain-data-validate-action@v0.1.1
        with:
          path: domain-profile.json

The action installs the latest @ai-domain-data/cli package at runtime and executes:

npx @ai-domain-data/cli aidd validate --path=<path>

Inputs

Name Description Default
path Path to the domain-profile.json file to validate. Relative to the repository root. domain-profile.json

Outputs

No outputs. The action exits non-zero if validation fails. CLI errors are printed in the workflow logs.

Validation Details

The action validates:

  • All required fields are present and non-empty
  • URLs are properly formatted
  • entity_type (if provided) is a valid schema.org @type value (Organization, Person, Blog, NGO, Community, Project, CreativeWork, SoftwareApplication, Thing)
  • jsonld (if provided) includes required @context: "https://schema.org" and @type fields
  • No additional properties beyond those defined in the schema

Requirements

  • Node.js 20+ runner (the action uses the Node 20 runtime).
  • Internet access to install @ai-domain-data/cli from npm.

License

MIT © Dylan Larson

About

GitHub Action that validates domain-profile.json against the AI Domain Data Standard v0.1 via the aidd CLI.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •