r2r validate

Validate the syntax and structure of .r2r/r2r-cli.yml configuration file.

Syntax

r2r validate [flags]

Description

The validate command checks your R2R configuration file for syntax errors and structural issues. Use this to catch configuration errors before running commands.

What it validates:

YAML syntax
Required fields (extension name, image)
Valid Docker image naming
No duplicate extension names

Examples

Basic Validation

r2r validate

Output when valid:

✓ Configuration is valid

Output when invalid:

✗ Configuration validation failed:
  - Line 3: Missing required field 'image' for extension 'eac'
  - Line 7: Invalid image name format 'invalid@image'

Validate Before Commit

# Validate configuration
r2r validate

# If valid, commit
if [ $? -eq 0 ]; then
    git add .r2r/r2r-cli.yml
    git commit -m "Update R2R configuration"
fi

Validation Rules

Extension Configuration

Each extension must have:

extensions:
  - name: 'eac'                                        # Required: string
    image: 'ghcr.io/ready-to-release/ext-eac:latest' # Required: valid image reference
    description: 'EAC automation'                      # Optional: string

Valid Image Reference Format

Valid examples:

ghcr.io/ready-to-release/ext-eac:latest
ghcr.io/ready-to-release/ext-eac:v1.2.3
ext-eac:dev (local images)

Invalid examples:

invalid@image (@ not allowed)
image name with spaces:latest
:latest (missing image name)

Extension Names

Valid names:

Alphanumeric characters
Hyphens allowed
No spaces
Unique across configuration

Examples:

✅ eac
✅ eac-dev
❌ my extension (spaces not allowed)

Common Validation Errors

Error: "Missing required field"

# Before (invalid)
extensions:
  - name: 'eac'

# After (valid)
extensions:
  - name: 'eac'
    image: 'ghcr.io/ready-to-release/ext-eac:latest'

Error: "Invalid YAML syntax"

# Before (invalid - bad indentation)
extensions:
- name: 'eac'
 image: 'ghcr.io/ready-to-release/ext-eac:latest'

# After (valid - consistent indentation)
extensions:
  - name: 'eac'
    image: 'ghcr.io/ready-to-release/ext-eac:latest'

Error: "Duplicate extension"

# Before (invalid)
extensions:
  - name: 'eac'
    image: 'ghcr.io/ready-to-release/ext-eac:latest'
  - name: 'eac'                                    # Duplicate!
    image: 'ghcr.io/ready-to-release/ext-eac:dev'

# After (valid)
extensions:
  - name: 'eac'
    image: 'ghcr.io/ready-to-release/ext-eac:latest'
  - name: 'eac-dev'                                # Renamed
    image: 'ghcr.io/ready-to-release/ext-eac:dev'