Refactor Windows build workflow for YTSage
Simplifies and modernizes the GitHub Actions workflow for building Windows releases. Updates Python version, streamlines steps for dependency installation, build, FFmpeg bundling, artifact packaging, and release creation. Uses more concise PowerShell scripts and updates action versions for improved maintainability.
This commit is contained in:
Your Name
+109
-249
@@ -9,281 +9,141 @@ permissions:
|
|||||||
contents: write
|
contents: write
|
||||||
|
|
||||||
env:
|
env:
|
||||||
PYTHON_VERSION: '3.13.6'
|
PYTHON_VERSION: '3.12.10'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build-windows:
|
build-windows:
|
||||||
runs-on: windows-latest
|
runs-on: windows-latest
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
shell: pwsh
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout code
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
- name: Extract version from tag
|
- name: Derive version from tag
|
||||||
id: get_version
|
id: version
|
||||||
shell: powershell
|
run: |
|
||||||
run: |
|
$tag = "${{ github.ref_name }}"
|
||||||
$tag = "${{ github.ref_name }}"
|
$ver = $tag -replace '^v',''
|
||||||
$version = $tag -replace '^v', ''
|
echo "VERSION=$ver" >> $env:GITHUB_OUTPUT
|
||||||
Write-Host "Extracted version: $version"
|
echo "VERSION=$ver" >> $env:GITHUB_ENV
|
||||||
echo "VERSION=$version" >> $env:GITHUB_OUTPUT
|
|
||||||
|
|
||||||
- name: Setup Python
|
- name: Setup Python ${{ env.PYTHON_VERSION }}
|
||||||
uses: actions/setup-python@v4
|
uses: actions/setup-python@v5
|
||||||
with:
|
with:
|
||||||
python-version: ${{ env.PYTHON_VERSION }}
|
python-version: ${{ env.PYTHON_VERSION }}
|
||||||
|
|
||||||
- name: Cache Python dependencies
|
- name: Create venv and install dependencies
|
||||||
uses: actions/cache@v3
|
run: |
|
||||||
with:
|
$py = $env:pythonLocation
|
||||||
path: |
|
& "$py\python.exe" -m venv venv
|
||||||
venv
|
.\venv\Scripts\Activate.ps1
|
||||||
~\AppData\Local\pip\Cache
|
python -m pip install --upgrade pip
|
||||||
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
|
pip install --no-cache-dir -r requirements.txt
|
||||||
restore-keys: |
|
pip install --no-cache-dir cx_Freeze yt-dlp
|
||||||
${{ runner.os }}-pip-
|
|
||||||
|
|
||||||
- name: Create virtual environment and install dependencies
|
- name: Build Standard (portable ZIP)
|
||||||
shell: powershell
|
run: |
|
||||||
run: |
|
.\venv\Scripts\Activate.ps1
|
||||||
python -m venv venv
|
$version = "$env:VERSION"
|
||||||
.\venv\Scripts\Activate.ps1
|
Write-Host "Building Standard v$version"
|
||||||
python -m pip install --upgrade pip
|
|
||||||
pip install --no-cache-dir -r requirements.txt
|
|
||||||
pip install --no-cache-dir cx_Freeze
|
|
||||||
pip install --no-cache-dir yt-dlp
|
|
||||||
|
|
||||||
- name: Prepare build variables
|
if (Test-Path "build") { Remove-Item "build" -Recurse -Force }
|
||||||
shell: powershell
|
if (Test-Path "dist") { Remove-Item "dist" -Recurse -Force }
|
||||||
run: |
|
|
||||||
$version = "${{ steps.get_version.outputs.VERSION }}"
|
|
||||||
echo "VERSION=$version" >> $env:GITHUB_ENV
|
|
||||||
Write-Host "Prepared build variables for version: $version"
|
|
||||||
|
|
||||||
- name: Build Standard Version (ZIP)
|
.\venv\Scripts\python.exe -m cx_Freeze.cli cxfreeze main.py `
|
||||||
shell: powershell
|
--target-dir "dist\YTSage" `
|
||||||
run: |
|
--base-name Win32GUI `
|
||||||
.\venv\Scripts\Activate.ps1
|
--icon "assets\branding\icons\YTSage.ico" `
|
||||||
$version = "$env:VERSION"
|
--target-name "YTSage-v$version.exe" `
|
||||||
Write-Host "Building Standard Version v$version ..."
|
--optimize 2 `
|
||||||
|
--packages "PySide6.QtCore,PySide6.QtGui,PySide6.QtWidgets,requests,PIL,packaging,markdown,playsound3,loguru,setuptools" `
|
||||||
|
--excludes "PySide6.QtBluetooth,PySide6.QtNetwork,PySide6.QtOpenGL,PySide6.QtPrintSupport,PySide6.QtSvg,PySide6.QtTest,PySide6.QtXml,PySide6.QtSql,PySide6.QtHelp,PySide6.QtMultimedia,PySide6.QtQml,PySide6.QtQuick,PySide6.QtWebEngineCore,PIL.ImageDraw,PIL.ImageFont,numpy,scipy,wx,pandas,tkinter,yt_dlp,unittest,test,tests" `
|
||||||
|
--include-files "src" `
|
||||||
|
--include-files "assets"
|
||||||
|
|
||||||
# Clean previous build artifacts
|
$stdScreenshots = "dist\YTSage\assets\branding\screenshots"
|
||||||
if (Test-Path "build\exe.*") { Remove-Item "build\exe.*" -Recurse -Force }
|
if (Test-Path $stdScreenshots) { Remove-Item $stdScreenshots -Recurse -Force }
|
||||||
if (Test-Path "build\bdist.*") { Remove-Item "build\bdist.*" -Recurse -Force }
|
|
||||||
if (Test-Path "dist") { Remove-Item "dist" -Recurse -Force }
|
|
||||||
|
|
||||||
# Build executable using cx_Freeze CLI
|
- name: Download FFmpeg bundle
|
||||||
cxfreeze main.py `
|
run: |
|
||||||
--target-dir "dist\YTSage" `
|
New-Item -ItemType Directory -Path "ffmpeg-temp" -Force | Out-Null
|
||||||
--base-name Win32GUI `
|
$ffmpegUrl = "https://github.com/GyanD/codexffmpeg/releases/download/7.1.1/ffmpeg-7.1.1-full_build.zip"
|
||||||
--icon "assets\branding\icons\YTSage.ico" `
|
Invoke-WebRequest -Uri $ffmpegUrl -OutFile "ffmpeg-temp\ffmpeg.zip"
|
||||||
--target-name "YTSage-v$version.exe" `
|
Expand-Archive -Path "ffmpeg-temp\ffmpeg.zip" -DestinationPath "ffmpeg-temp" -Force
|
||||||
--optimize 2 `
|
$ffmpegDir = Get-ChildItem -Path "ffmpeg-temp" -Directory | Where-Object { $_.Name -like "ffmpeg-*" } | Select-Object -First 1
|
||||||
--packages "PySide6.QtCore,PySide6.QtGui,PySide6.QtWidgets,requests,PIL,packaging,markdown,playsound3,loguru,setuptools" `
|
if (-not $ffmpegDir) { Write-Error "FFmpeg dir not found"; exit 1 }
|
||||||
--excludes "PySide6.QtBluetooth,PySide6.QtNetwork,PySide6.QtOpenGL,PySide6.QtPrintSupport,PySide6.QtSvg,PySide6.QtTest,PySide6.QtXml,PySide6.QtSql,PySide6.QtHelp,PySide6.QtMultimedia,PySide6.QtQml,PySide6.QtQuick,PySide6.QtWebEngineCore,PIL.ImageDraw,PIL.ImageFont,numpy,scipy,wx,pandas,tkinter,yt_dlp,unittest,test,tests" `
|
$ffmpegBin = Join-Path $ffmpegDir.FullName "bin"
|
||||||
--include-files "src" `
|
echo "FFMPEG_PATH=$ffmpegBin" >> $env:GITHUB_ENV
|
||||||
--include-files "assets"
|
|
||||||
|
|
||||||
# Exclude screenshots folder from Standard build output
|
- name: Build FFmpeg bundle (portable ZIP)
|
||||||
$stdScreenshots = "dist\YTSage\assets\branding\screenshots"
|
run: |
|
||||||
if (Test-Path $stdScreenshots) {
|
.\venv\Scripts\Activate.ps1
|
||||||
Remove-Item $stdScreenshots -Recurse -Force
|
$version = "$env:VERSION"
|
||||||
Write-Host "Removed screenshots from Standard build: $stdScreenshots"
|
Write-Host "Building FFmpeg bundle v$version"
|
||||||
}
|
|
||||||
|
|
||||||
- name: Setup FFmpeg for bundle
|
if (Test-Path "build\exe.*") { Remove-Item "build\exe.*" -Recurse -Force }
|
||||||
shell: powershell
|
if (Test-Path "build\bdist.*") { Remove-Item "build\bdist.*" -Recurse -Force }
|
||||||
run: |
|
|
||||||
Write-Host "Setting up FFmpeg for bundled version..."
|
|
||||||
|
|
||||||
# Create ffmpeg directory
|
.\venv\Scripts\python.exe -m cx_Freeze.cli cxfreeze main.py `
|
||||||
New-Item -ItemType Directory -Path "ffmpeg-temp" -Force
|
--target-dir "dist\YTSage-FFmpeg" `
|
||||||
|
--base-name Win32GUI `
|
||||||
|
--icon "assets\branding\icons\YTSage.ico" `
|
||||||
|
--target-name "YTSage-v$version-ffmpeg.exe" `
|
||||||
|
--optimize 2 `
|
||||||
|
--packages "PySide6.QtCore,PySide6.QtGui,PySide6.QtWidgets,requests,PIL,packaging,markdown,playsound3,loguru,setuptools" `
|
||||||
|
--excludes "PySide6.QtBluetooth,PySide6.QtNetwork,PySide6.QtOpenGL,PySide6.QtPrintSupport,PySide6.QtSvg,PySide6.QtTest,PySide6.QtXml,PySide6.QtSql,PySide6.QtHelp,PySide6.QtMultimedia,PySide6.QtQml,PySide6.QtQuick,PySide6.QtWebEngineCore,PIL.ImageDraw,PIL.ImageFont,numpy,scipy,wx,pandas,tkinter,yt_dlp,unittest,test,tests" `
|
||||||
|
--include-files "src" `
|
||||||
|
--include-files "assets"
|
||||||
|
|
||||||
# Download FFmpeg
|
if ($env:FFMPEG_PATH) {
|
||||||
$ffmpegUrl = "https://github.com/GyanD/codexffmpeg/releases/download/7.1.1/ffmpeg-7.1.1-full_build.zip"
|
$dest = "dist\YTSage-FFmpeg"
|
||||||
Write-Host "Downloading FFmpeg from: $ffmpegUrl"
|
foreach ($n in 'ffmpeg.exe','ffprobe.exe','ffplay.exe') {
|
||||||
Invoke-WebRequest -Uri $ffmpegUrl -OutFile "ffmpeg-temp\ffmpeg.zip"
|
$src = Join-Path $env:FFMPEG_PATH $n
|
||||||
|
if (Test-Path $src) { Copy-Item $src -Destination (Join-Path $dest $n) -Force }
|
||||||
# Extract FFmpeg
|
|
||||||
Expand-Archive -Path "ffmpeg-temp\ffmpeg.zip" -DestinationPath "ffmpeg-temp" -Force
|
|
||||||
|
|
||||||
# Find the extracted directory (GyanD ffmpeg has specific naming)
|
|
||||||
$ffmpegDir = Get-ChildItem -Path "ffmpeg-temp" -Directory | Where-Object { $_.Name -like "ffmpeg-*" } | Select-Object -First 1
|
|
||||||
|
|
||||||
if ($ffmpegDir) {
|
|
||||||
# Set environment variable for the build
|
|
||||||
$ffmpegBinPath = Join-Path $ffmpegDir.FullName "bin"
|
|
||||||
Write-Host "FFmpeg binaries found at: $ffmpegBinPath"
|
|
||||||
echo "FFMPEG_PATH=$ffmpegBinPath" >> $env:GITHUB_ENV
|
|
||||||
|
|
||||||
# Verify files exist
|
|
||||||
$ffmpegExe = Join-Path $ffmpegBinPath "ffmpeg.exe"
|
|
||||||
$ffprobeExe = Join-Path $ffmpegBinPath "ffprobe.exe"
|
|
||||||
$ffplayExe = Join-Path $ffmpegBinPath "ffplay.exe"
|
|
||||||
|
|
||||||
if (Test-Path $ffmpegExe) {
|
|
||||||
Write-Host "[OK] ffmpeg.exe found"
|
|
||||||
} else {
|
|
||||||
Write-Host "[ERROR] ffmpeg.exe missing"
|
|
||||||
}
|
|
||||||
if (Test-Path $ffprobeExe) {
|
|
||||||
Write-Host "[OK] ffprobe.exe found"
|
|
||||||
} else {
|
|
||||||
Write-Host "[ERROR] ffprobe.exe missing"
|
|
||||||
}
|
|
||||||
if (Test-Path $ffplayExe) {
|
|
||||||
Write-Host "[OK] ffplay.exe found"
|
|
||||||
} else {
|
|
||||||
Write-Host "[ERROR] ffplay.exe missing"
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
Write-Host "Error: Could not find FFmpeg directory after extraction"
|
|
||||||
exit 1
|
|
||||||
}
|
|
||||||
|
|
||||||
- name: Build FFmpeg Version (ZIP)
|
|
||||||
shell: powershell
|
|
||||||
run: |
|
|
||||||
.\venv\Scripts\Activate.ps1
|
|
||||||
$version = "$env:VERSION"
|
|
||||||
Write-Host "Building FFmpeg Version v$version ..."
|
|
||||||
|
|
||||||
# Clean previous build artifacts
|
|
||||||
if (Test-Path "build\exe.*") { Remove-Item "build\exe.*" -Recurse -Force }
|
|
||||||
if (Test-Path "build\bdist.*") { Remove-Item "build\bdist.*" -Recurse -Force }
|
|
||||||
|
|
||||||
# Build executable with FFmpeg using cx_Freeze CLI
|
|
||||||
cxfreeze main.py `
|
|
||||||
--target-dir "dist\YTSage-FFmpeg" `
|
|
||||||
--base-name Win32GUI `
|
|
||||||
--icon "assets\branding\icons\YTSage.ico" `
|
|
||||||
--target-name "YTSage-v$version-ffmpeg.exe" `
|
|
||||||
--optimize 2 `
|
|
||||||
--packages "PySide6.QtCore,PySide6.QtGui,PySide6.QtWidgets,requests,PIL,packaging,markdown,playsound3,loguru,setuptools" `
|
|
||||||
--excludes "PySide6.QtBluetooth,PySide6.QtNetwork,PySide6.QtOpenGL,PySide6.QtPrintSupport,PySide6.QtSvg,PySide6.QtTest,PySide6.QtXml,PySide6.QtSql,PySide6.QtHelp,PySide6.QtMultimedia,PySide6.QtQml,PySide6.QtQuick,PySide6.QtWebEngineCore,PIL.ImageDraw,PIL.ImageFont,numpy,scipy,wx,pandas,tkinter,yt_dlp,unittest,test,tests" `
|
|
||||||
--include-files "src" `
|
|
||||||
--include-files "assets"
|
|
||||||
|
|
||||||
# Copy FFmpeg binaries into dist folder post-build (more reliable than CLI include)
|
|
||||||
if ($env:FFMPEG_PATH) {
|
|
||||||
$destDir = "dist\YTSage-FFmpeg"
|
|
||||||
$ffmpegExe = Join-Path $env:FFMPEG_PATH "ffmpeg.exe"
|
|
||||||
$ffprobeExe = Join-Path $env:FFMPEG_PATH "ffprobe.exe"
|
|
||||||
$ffplayExe = Join-Path $env:FFMPEG_PATH "ffplay.exe"
|
|
||||||
|
|
||||||
foreach ($file in @($ffmpegExe, $ffprobeExe, $ffplayExe)) {
|
|
||||||
if (Test-Path $file) {
|
|
||||||
$name = Split-Path $file -Leaf
|
|
||||||
Copy-Item $file -Destination (Join-Path $destDir $name) -Force
|
|
||||||
Write-Host "Copied $name into $destDir"
|
|
||||||
} else {
|
|
||||||
Write-Host "Warning: FFmpeg binary not found: $file"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
# Exclude screenshots folder from FFmpeg build output
|
$ffShots = "dist\YTSage-FFmpeg\assets\branding\screenshots"
|
||||||
$ffScreenshots = "dist\YTSage-FFmpeg\assets\branding\screenshots"
|
if (Test-Path $ffShots) { Remove-Item $ffShots -Recurse -Force }
|
||||||
if (Test-Path $ffScreenshots) {
|
|
||||||
Remove-Item $ffScreenshots -Recurse -Force
|
|
||||||
Write-Host "Removed screenshots from FFmpeg build: $ffScreenshots"
|
|
||||||
}
|
|
||||||
|
|
||||||
- name: Package and prepare release artifacts (ZIPs)
|
- name: Package artifacts
|
||||||
shell: powershell
|
run: |
|
||||||
run: |
|
$version = "$env:VERSION"
|
||||||
$version = "${{ steps.get_version.outputs.VERSION }}"
|
New-Item -ItemType Directory -Path "artifacts" -Force | Out-Null
|
||||||
|
|
||||||
Write-Host "Preparing ZIP artifacts for version: $version"
|
$std = "artifacts\YTSage-v$version-portable.zip"
|
||||||
New-Item -ItemType Directory -Path "artifacts" -Force
|
if (Test-Path "dist\YTSage") {
|
||||||
|
if (Test-Path $std) { Remove-Item $std -Force }
|
||||||
# List dist directories
|
Compress-Archive -Path "dist\YTSage\*" -DestinationPath $std -CompressionLevel Optimal
|
||||||
Write-Host "Files in dist directory:"
|
|
||||||
if (Test-Path "dist") {
|
|
||||||
Get-ChildItem -Path "dist" -Recurse | ForEach-Object { Write-Host " $($_.FullName)" }
|
|
||||||
} else {
|
|
||||||
Write-Host " No dist directory found!"
|
|
||||||
exit 1
|
|
||||||
}
|
|
||||||
|
|
||||||
# Create Standard ZIP (portable)
|
|
||||||
$standardDist = Join-Path (Get-Location) "dist\YTSage"
|
|
||||||
if (Test-Path $standardDist) {
|
|
||||||
$stdZip = "artifacts\YTSage-v$version-portable.zip"
|
|
||||||
if (Test-Path $stdZip) { Remove-Item $stdZip -Force }
|
|
||||||
Compress-Archive -Path "$standardDist\*" -DestinationPath $stdZip -CompressionLevel Optimal
|
|
||||||
Write-Host "Created: $(Resolve-Path $stdZip)"
|
|
||||||
} else {
|
|
||||||
Write-Host "Warning: Standard dist folder not found at $standardDist"
|
|
||||||
}
|
|
||||||
|
|
||||||
# Create FFmpeg ZIP (portable)
|
|
||||||
$ffmpegDist = Join-Path (Get-Location) "dist\YTSage-FFmpeg"
|
|
||||||
if (Test-Path $ffmpegDist) {
|
|
||||||
$ffZip = "artifacts\YTSage-v$version-ffmpeg-portable.zip"
|
|
||||||
if (Test-Path $ffZip) { Remove-Item $ffZip -Force }
|
|
||||||
Compress-Archive -Path "$ffmpegDist\*" -DestinationPath $ffZip -CompressionLevel Optimal
|
|
||||||
Write-Host "Created: $(Resolve-Path $ffZip)"
|
|
||||||
} else {
|
|
||||||
Write-Host "Warning: FFmpeg dist folder not found at $ffmpegDist"
|
|
||||||
}
|
|
||||||
|
|
||||||
# List all artifacts
|
|
||||||
Write-Host "Final artifacts:"
|
|
||||||
if (Test-Path "artifacts") {
|
|
||||||
$artifactFiles = Get-ChildItem artifacts
|
|
||||||
if ($artifactFiles) {
|
|
||||||
$artifactFiles | ForEach-Object { Write-Host " $($_.Name)" }
|
|
||||||
} else {
|
|
||||||
Write-Host " No artifacts created!"
|
|
||||||
}
|
}
|
||||||
} else {
|
|
||||||
Write-Host " Artifacts directory not found!"
|
|
||||||
}
|
|
||||||
|
|
||||||
- name: Create draft release
|
$ff = "artifacts\YTSage-v$version-ffmpeg-portable.zip"
|
||||||
uses: softprops/action-gh-release@v1
|
if (Test-Path "dist\YTSage-FFmpeg") {
|
||||||
with:
|
if (Test-Path $ff) { Remove-Item $ff -Force }
|
||||||
tag_name: ${{ github.ref_name }}
|
Compress-Archive -Path "dist\YTSage-FFmpeg\*" -DestinationPath $ff -CompressionLevel Optimal
|
||||||
name: YTSage ${{ github.ref_name }}
|
}
|
||||||
draft: true
|
|
||||||
prerelease: false
|
|
||||||
body: |
|
|
||||||
# YTSage ${{ github.ref_name }}
|
|
||||||
|
|
||||||
**Release Date**: ${{ github.event.head_commit.timestamp }}
|
Write-Host "Artifacts:"
|
||||||
|
Get-ChildItem artifacts | ForEach-Object { Write-Host " - $($_.Name)" }
|
||||||
|
|
||||||
## Downloads
|
- name: Create draft release
|
||||||
|
uses: softprops/action-gh-release@v2
|
||||||
|
with:
|
||||||
|
tag_name: ${{ github.ref_name }}
|
||||||
|
name: YTSage ${{ github.ref_name }}
|
||||||
|
draft: true
|
||||||
|
prerelease: false
|
||||||
|
body: |
|
||||||
|
## Downloads
|
||||||
|
|
||||||
### Standard Version (ZIP)
|
- YTSage-v${{ steps.version.outputs.VERSION }}-portable.zip (portable)
|
||||||
- **YTSage-v${{ steps.get_version.outputs.VERSION }}-portable.zip** – Portable ZIP (downloads FFmpeg on first use if needed)
|
- YTSage-v${{ steps.version.outputs.VERSION }}-ffmpeg-portable.zip (portable with FFmpeg included)
|
||||||
|
|
||||||
### FFmpeg Bundle Version (ZIP)
|
Extract and run the EXE. Console window is hidden.
|
||||||
- **YTSage-v${{ steps.get_version.outputs.VERSION }}-ffmpeg-portable.zip** – Portable ZIP with FFmpeg included
|
files: |
|
||||||
|
artifacts/*
|
||||||
## Installation / Usage
|
|
||||||
|
|
||||||
1. Download the `.zip` file you want.
|
|
||||||
2. Right-click the ZIP, choose Properties, and if you see "Unblock", check it and Apply.
|
|
||||||
3. Extract the ZIP to a folder (e.g., `C:\Apps\YTSage`).
|
|
||||||
4. Run `YTSage-v${{ steps.get_version.outputs.VERSION }}.exe` inside the extracted folder.
|
|
||||||
|
|
||||||
## System Requirements
|
|
||||||
|
|
||||||
- Windows 10/11 (64-bit)
|
|
||||||
- Internet connection for yt-dlp updates
|
|
||||||
|
|
||||||
## Notes
|
|
||||||
|
|
||||||
- **Standard version**: Downloads FFmpeg automatically when needed.
|
|
||||||
- **FFmpeg bundle**: Includes FFmpeg binaries for offline use.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Full Changelog**: https://github.com/${{ github.repository }}/compare/${{ github.ref_name }}
|
|
||||||
files: |
|
|
||||||
artifacts/*
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
Reference in New Issue
Block a user