Skip to content

WORKFLOW_FIX.md

Latest commit

 

History

History
103 lines (76 loc) · 2.69 KB

WORKFLOW_FIX.md

File metadata and controls

103 lines (76 loc) · 2.69 KB
Raw

GitHub Workflow Fix Summary

✅ Issue Fixed: YAML Syntax Error on Line 117

🔍 Problem Identified

The GitHub workflow file .github/workflows/release.yml had multiple YAML syntax errors:

  1. Misplaced shell commands in the env section
  2. Duplicate steps with conflicting IDs
  3. Broken YAML structure around line 117
  4. Mixed workflow patterns causing validation failures

🔧 Solution Applied

Complete Workflow Rewrite: Replaced the corrupted workflow file with a clean, working version that:

  1. ✅ Proper YAML syntax - No syntax errors
  2. ✅ Single responsibility - Each step has one clear purpose
  3. ✅ Modern GitHub Actions - Uses softprops/action-gh-release@v1
  4. ✅ Clean structure - Proper indentation and formatting

📁 What the Fixed Workflow Does

name: Release Extension

on:
  push:
    tags:
      - 'v*'  # Triggers on version tags like v2.1

jobs:
  release:
    runs-on: ubuntu-latest
    
    steps:
    - Checkout code
    - Setup build environment
    - Get version from tag
    - Create extension package
    - Create source package  
    - Create GitHub release with attachments

🚀 How to Use the Fixed Workflow

  1. Commit the fix:

    git add .github/workflows/release.yml
git commit -m "Fix workflow YAML syntax"
git push origin main

  2. Create a release:

    git tag v2.1
git push origin v2.1

  3. Workflow will automatically:

    • Build extension packages
    • Create GitHub release
    • Attach downloadable files

🎯 What Gets Built

When triggered, the workflow creates:

  1. Extension Package: always-on-top-v{VERSION}.zip

    • Ready for GNOME Extensions submission
    • Contains compiled schemas
    • Proper UUID directory structure

  2. Source Package: always-on-top-source-v{VERSION}.zip

    • Complete source code
    • Excludes generated files
    • For developers and contributors

📋 Validation Results

The workflow has been validated and:

  • ✅ YAML syntax is correct
  • ✅ All required sections present
  • ✅ Proper GitHub Actions structure
  • ✅ No deprecated actions used
  • ✅ Environment variables properly set

🔧 Additional Tools Created

  1. validate-workflow.sh - Tests workflow syntax locally
  2. validate-extension.sh - Validates extension packages
  3. package-clean.sh - Creates GNOME Extensions compatible packages

🎉 Ready for Action

The GitHub workflow is now fixed and ready to use! The next time you push a version tag, it will automatically:

  1. Build your extension
  2. Create a GitHub release
  3. Attach both extension and source packages
  4. Generate a formatted release description

No more YAML syntax errors! 🚀