YAML Linting Issues in GitHub Actions Workflow

[coderabbitai]

Problem Description

The new GitHub Actions workflow file .github/workflows/insta-merge.yaml introduced in PR #1365 breaks the repository's YAML linter, causing CI/CD pipeline failures and code quality issues.

Root Cause Analysis

The workflow file may contain several YAML formatting and structural issues that violate the repository's linting standards:

1. Indentation Issues: Inconsistent spacing or incorrect indentation levels
2. String Quoting: Missing quotes around strings that contain special characters
3. Line Length: Lines exceeding maximum character limits
4. Trailing Whitespace: Unnecessary spaces at line endings
5. Document Structure: Improper YAML document formatting or missing document separators

Impact

• CI/CD Pipeline Failures: Linting failures block the build process
• Code Quality Degradation: Inconsistent YAML formatting affects maintainability
• Developer Experience: Developers encounter linting errors during local development
• Repository Standards: Violates established code quality standards

Proposed Solutions

Option 1: Fix Current Workflow File

# Apply proper YAML formatting to existing workflow
name: "Insta Merge Konflux PRs"

on:
  pull_request:
    paths:
      - "manifests/base/params-latest.env"
    types:
      - opened
    branches:
      - main

Option 2: Implement YAML Linting Rules

• Configure .yamllint with appropriate rules
• Add YAML linting to pre-commit hooks
• Integrate YAML validation into CI pipeline

Option 3: Automated YAML Formatting

• Use tools like yamllint with --fix option
• Implement automated formatting in CI/CD pipeline
• Add formatting checks to pull request validation

Option 4: Repository-Wide YAML Standardization

• Audit all YAML files in the repository
• Establish consistent formatting standards
• Create documentation for YAML best practices

Acceptance Criteria

• The .github/workflows/insta-merge.yaml file passes all YAML linting checks
• No YAML linting errors are reported in CI/CD pipelines
• The workflow maintains its original functionality after formatting fixes
• All existing GitHub Actions workflows continue to pass linting
• YAML linting rules are documented and enforced consistently

Implementation Guidance

1. Immediate Fix: Address the specific linting issues in the workflow file
2. Validation: Run yamllint .github/workflows/insta-merge.yaml to identify specific issues
3. Testing: Verify the workflow still functions correctly after formatting changes
4. Documentation: Update any relevant documentation about YAML standards

Testing Approach

# Validate YAML syntax
yamllint .github/workflows/insta-merge.yaml

# Check GitHub Actions workflow syntax
gh workflow view insta-merge.yaml --repo opendatahub-io/notebooks

# Test workflow execution in development environment

Related Context

• PR: RHOAIENG-28188: add .tekton/ files for version 2025a-v1.34 #1365 - Introduction of Insta Merge Konflux PRs workflow
• Comment: RHOAIENG-28188: add .tekton/ files for version 2025a-v1.34 #1365 (comment)
• Requested by: @jiridanek

This issue continues the established pattern of systematic code quality improvements through detailed issue tracking, ensuring comprehensive resolution of YAML linting problems while maintaining workflow functionality.

[jiridanek]

rabbit has lots of other interesting suggestions on that comment/pr