.github/workflows/build.yml

   1 name: Build Artifacts
   2 on:
   3   workflow_call:
   4     inputs:
   5       version:
   6         required: true
   7         type: string
   8       channel:
   9         required: false
  10         default: stable
  11         type: string
  12       unix:
  13         default: true
  14         type: boolean
  15       linux_static:
  16         default: true
  17         type: boolean
  18       linux_arm:
  19         default: true
  20         type: boolean
  21       macos:
  22         default: true
  23         type: boolean
  24       macos_legacy:
  25         default: true
  26         type: boolean
  27       windows:
  28         default: true
  29         type: boolean
  30       windows32:
  31         default: true
  32         type: boolean
  33       origin:
  34         required: false
  35         default: ''
  36         type: string
  37     secrets:
  38       GPG_SIGNING_KEY:
  39         required: false
  40
  41   workflow_dispatch:
  42     inputs:
  43       version:
  44         description: |
  45           VERSION: yyyy.mm.dd[.rev] or rev
  46         required: true
  47         type: string
  48       channel:
  49         description: |
  50           SOURCE of this build's updates: stable/nightly/master/<repo>
  51         required: true
  52         default: stable
  53         type: string
  54       unix:
  55         description: yt-dlp, yt-dlp.tar.gz
  56         default: true
  57         type: boolean
  58       linux_static:
  59         description: yt-dlp_linux
  60         default: true
  61         type: boolean
  62       linux_arm:
  63         description: yt-dlp_linux_aarch64, yt-dlp_linux_armv7l
  64         default: true
  65         type: boolean
  66       macos:
  67         description: yt-dlp_macos, yt-dlp_macos.zip
  68         default: true
  69         type: boolean
  70       macos_legacy:
  71         description: yt-dlp_macos_legacy
  72         default: true
  73         type: boolean
  74       windows:
  75         description: yt-dlp.exe, yt-dlp_min.exe, yt-dlp_win.zip
  76         default: true
  77         type: boolean
  78       windows32:
  79         description: yt-dlp_x86.exe
  80         default: true
  81         type: boolean
  82       origin:
  83         description: Origin
  84         required: false
  85         default: 'current repo'
  86         type: choice
  87         options:
  88         - 'current repo'
  89
  90 permissions:
  91   contents: read
  92
  93 jobs:
  94   process:
  95     runs-on: ubuntu-latest
  96     outputs:
  97       origin: ${{ steps.process_origin.outputs.origin }}
  98     steps:
  99       - name: Process origin
 100         id: process_origin
 101         run: |
 102           echo "origin=${{ inputs.origin == 'current repo' && github.repository || inputs.origin }}" | tee "$GITHUB_OUTPUT"
 103
 104   unix:
 105     needs: process
 106     if: inputs.unix
 107     runs-on: ubuntu-latest
 108     steps:
 109       - uses: actions/checkout@v4
 110         with:
 111           fetch-depth: 0  # Needed for changelog
 112       - uses: actions/setup-python@v5
 113         with:
 114           python-version: "3.10"
 115       - name: Install Requirements
 116         run: |
 117           sudo apt -y install zip pandoc man sed
 118       - name: Prepare
 119         run: |
 120           python devscripts/update-version.py -c "${{ inputs.channel }}" -r "${{ needs.process.outputs.origin }}" "${{ inputs.version }}"
 121           python devscripts/update_changelog.py -vv
 122           python devscripts/make_lazy_extractors.py
 123       - name: Build Unix platform-independent binary
 124         run: |
 125           make all tar
 126       - name: Verify --update-to
 127         if: vars.UPDATE_TO_VERIFICATION
 128         run: |
 129           chmod +x ./yt-dlp
 130           cp ./yt-dlp ./yt-dlp_downgraded
 131           version="$(./yt-dlp --version)"
 132           ./yt-dlp_downgraded -v --update-to yt-dlp/yt-dlp@2023.03.04
 133           downgraded_version="$(./yt-dlp_downgraded --version)"
 134           [[ "$version" != "$downgraded_version" ]]
 135       - name: Upload artifacts
 136         uses: actions/upload-artifact@v4
 137         with:
 138           name: build-bin-${{ github.job }}
 139           path: |
 140             yt-dlp
 141             yt-dlp.tar.gz
 142           compression-level: 0
 143
 144   linux_static:
 145     needs: process
 146     if: inputs.linux_static
 147     runs-on: ubuntu-latest
 148     steps:
 149       - uses: actions/checkout@v4
 150       - name: Build static executable
 151         env:
 152           channel: ${{ inputs.channel }}
 153           origin: ${{ needs.process.outputs.origin }}
 154           version: ${{ inputs.version }}
 155         run: |
 156           mkdir ~/build
 157           cd bundle/docker
 158           docker compose up --build static
 159           sudo chown "${USER}:docker" ~/build/yt-dlp_linux
 160       - name: Verify --update-to
 161         if: vars.UPDATE_TO_VERIFICATION
 162         run: |
 163           chmod +x ~/build/yt-dlp_linux
 164           cp ~/build/yt-dlp_linux ~/build/yt-dlp_linux_downgraded
 165           version="$(~/build/yt-dlp_linux --version)"
 166           ~/build/yt-dlp_linux_downgraded -v --update-to yt-dlp/yt-dlp@2023.03.04
 167           downgraded_version="$(~/build/yt-dlp_linux_downgraded --version)"
 168           [[ "$version" != "$downgraded_version" ]]
 169       - name: Upload artifacts
 170         uses: actions/upload-artifact@v4
 171         with:
 172           name: build-bin-${{ github.job }}
 173           path: |
 174             ~/build/yt-dlp_linux
 175           compression-level: 0
 176
 177   linux_arm:
 178     needs: process
 179     if: inputs.linux_arm
 180     permissions:
 181       contents: read
 182       packages: write # for creating cache
 183     runs-on: ubuntu-latest
 184     strategy:
 185       matrix:
 186         architecture:
 187           - armv7
 188           - aarch64
 189
 190     steps:
 191       - uses: actions/checkout@v4
 192         with:
 193           path: ./repo
 194       - name: Virtualized Install, Prepare & Build
 195         uses: yt-dlp/run-on-arch-action@v2
 196         with:
 197           # Ref: https://github.com/uraimo/run-on-arch-action/issues/55
 198           env: |
 199             GITHUB_WORKFLOW: build
 200           githubToken: ${{ github.token }} # To cache image
 201           arch: ${{ matrix.architecture }}
 202           distro: ubuntu18.04 # Standalone executable should be built on minimum supported OS
 203           dockerRunArgs: --volume "${PWD}/repo:/repo"
 204           install: | # Installing Python 3.10 from the Deadsnakes repo raises errors
 205             apt update
 206             apt -y install zlib1g-dev libffi-dev python3.8 python3.8-dev python3.8-distutils python3-pip
 207             python3.8 -m pip install -U pip setuptools wheel
 208             # Cannot access any files from the repo directory at this stage
 209             python3.8 -m pip install -U Pyinstaller mutagen pycryptodomex websockets brotli certifi secretstorage cffi
 210
 211           run: |
 212             cd repo
 213             python3.8 devscripts/install_deps.py -o --include build
 214             python3.8 devscripts/install_deps.py --include pyinstaller --include secretstorage  # Cached version may be out of date
 215             python3.8 devscripts/update-version.py -c "${{ inputs.channel }}" -r "${{ needs.process.outputs.origin }}" "${{ inputs.version }}"
 216             python3.8 devscripts/make_lazy_extractors.py
 217             python3.8 -m bundle.pyinstaller
 218
 219             if ${{ vars.UPDATE_TO_VERIFICATION && 'true' || 'false' }}; then
 220               arch="${{ (matrix.architecture == 'armv7' && 'armv7l') || matrix.architecture }}"
 221               chmod +x ./dist/yt-dlp_linux_${arch}
 222               cp ./dist/yt-dlp_linux_${arch} ./dist/yt-dlp_linux_${arch}_downgraded
 223               version="$(./dist/yt-dlp_linux_${arch} --version)"
 224               ./dist/yt-dlp_linux_${arch}_downgraded -v --update-to yt-dlp/yt-dlp@2023.03.04
 225               downgraded_version="$(./dist/yt-dlp_linux_${arch}_downgraded --version)"
 226               [[ "$version" != "$downgraded_version" ]]
 227             fi
 228
 229       - name: Upload artifacts
 230         uses: actions/upload-artifact@v4
 231         with:
 232           name: build-bin-linux_${{ matrix.architecture }}
 233           path: | # run-on-arch-action designates armv7l as armv7
 234             repo/dist/yt-dlp_linux_${{ (matrix.architecture == 'armv7' && 'armv7l') || matrix.architecture }}
 235           compression-level: 0
 236
 237   macos:
 238     needs: process
 239     if: inputs.macos
 240     runs-on: macos-11
 241
 242     steps:
 243       - uses: actions/checkout@v4
 244       # NB: Building universal2 does not work with python from actions/setup-python
 245       - name: Install Requirements
 246         run: |
 247           brew install coreutils
 248           python3 devscripts/install_deps.py --user -o --include build
 249           python3 devscripts/install_deps.py --print --include pyinstaller > requirements.txt
 250           # We need to ignore wheels otherwise we break universal2 builds
 251           python3 -m pip install -U --user --no-binary :all: -r requirements.txt
 252           # We need to fuse our own universal2 wheels for curl_cffi
 253           python3 -m pip install -U --user delocate
 254           mkdir curl_cffi_whls curl_cffi_universal2
 255           python3 devscripts/install_deps.py --print -o --include curl-cffi > requirements.txt
 256           for platform in "macosx_11_0_arm64" "macosx_11_0_x86_64"; do
 257             python3 -m pip download \
 258               --only-binary=:all: \
 259               --platform "${platform}" \
 260               --pre -d curl_cffi_whls \
 261               -r requirements.txt
 262           done
 263           python3 -m delocate.cmd.delocate_fuse curl_cffi_whls/curl_cffi*.whl -w curl_cffi_universal2
 264           python3 -m delocate.cmd.delocate_fuse curl_cffi_whls/cffi*.whl -w curl_cffi_universal2
 265           cd curl_cffi_universal2
 266           for wheel in *cffi*.whl; do mv -n -- "${wheel}" "${wheel/x86_64/universal2}"; done
 267           python3 -m pip install -U --user *cffi*.whl
 268
 269       - name: Prepare
 270         run: |
 271           python3 devscripts/update-version.py -c "${{ inputs.channel }}" -r "${{ needs.process.outputs.origin }}" "${{ inputs.version }}"
 272           python3 devscripts/make_lazy_extractors.py
 273       - name: Build
 274         run: |
 275           python3 -m bundle.pyinstaller --target-architecture universal2 --onedir
 276           (cd ./dist/yt-dlp_macos && zip -r ../yt-dlp_macos.zip .)
 277           python3 -m bundle.pyinstaller --target-architecture universal2
 278
 279       - name: Verify --update-to
 280         if: vars.UPDATE_TO_VERIFICATION
 281         run: |
 282           chmod +x ./dist/yt-dlp_macos
 283           cp ./dist/yt-dlp_macos ./dist/yt-dlp_macos_downgraded
 284           version="$(./dist/yt-dlp_macos --version)"
 285           ./dist/yt-dlp_macos_downgraded -v --update-to yt-dlp/yt-dlp@2023.03.04
 286           downgraded_version="$(./dist/yt-dlp_macos_downgraded --version)"
 287           [[ "$version" != "$downgraded_version" ]]
 288
 289       - name: Upload artifacts
 290         uses: actions/upload-artifact@v4
 291         with:
 292           name: build-bin-${{ github.job }}
 293           path: |
 294             dist/yt-dlp_macos
 295             dist/yt-dlp_macos.zip
 296           compression-level: 0
 297
 298   macos_legacy:
 299     needs: process
 300     if: inputs.macos_legacy
 301     runs-on: macos-12
 302
 303     steps:
 304       - uses: actions/checkout@v4
 305       - name: Install Python
 306         # We need the official Python, because the GA ones only support newer macOS versions
 307         env:
 308           PYTHON_VERSION: 3.10.5
 309           MACOSX_DEPLOYMENT_TARGET: 10.9 # Used up by the Python build tools
 310         run: |
 311           # Hack to get the latest patch version. Uncomment if needed
 312           #brew install python@3.10
 313           #export PYTHON_VERSION=$( $(brew --prefix)/opt/python@3.10/bin/python3 --version | cut -d ' ' -f 2 )
 314           curl https://www.python.org/ftp/python/${PYTHON_VERSION}/python-${PYTHON_VERSION}-macos11.pkg -o "python.pkg"
 315           sudo installer -pkg python.pkg -target /
 316           python3 --version
 317       - name: Install Requirements
 318         run: |
 319           brew install coreutils
 320           python3 devscripts/install_deps.py --user -o --include build
 321           python3 devscripts/install_deps.py --user --include pyinstaller
 322
 323       - name: Prepare
 324         run: |
 325           python3 devscripts/update-version.py -c "${{ inputs.channel }}" -r "${{ needs.process.outputs.origin }}" "${{ inputs.version }}"
 326           python3 devscripts/make_lazy_extractors.py
 327       - name: Build
 328         run: |
 329           python3 -m bundle.pyinstaller
 330           mv dist/yt-dlp_macos dist/yt-dlp_macos_legacy
 331
 332       - name: Verify --update-to
 333         if: vars.UPDATE_TO_VERIFICATION
 334         run: |
 335           chmod +x ./dist/yt-dlp_macos_legacy
 336           cp ./dist/yt-dlp_macos_legacy ./dist/yt-dlp_macos_legacy_downgraded
 337           version="$(./dist/yt-dlp_macos_legacy --version)"
 338           ./dist/yt-dlp_macos_legacy_downgraded -v --update-to yt-dlp/yt-dlp@2023.03.04
 339           downgraded_version="$(./dist/yt-dlp_macos_legacy_downgraded --version)"
 340           [[ "$version" != "$downgraded_version" ]]
 341
 342       - name: Upload artifacts
 343         uses: actions/upload-artifact@v4
 344         with:
 345           name: build-bin-${{ github.job }}
 346           path: |
 347             dist/yt-dlp_macos_legacy
 348           compression-level: 0
 349
 350   windows:
 351     needs: process
 352     if: inputs.windows
 353     runs-on: windows-latest
 354
 355     steps:
 356       - uses: actions/checkout@v4
 357       - uses: actions/setup-python@v5
 358         with: # 3.8 is used for Win7 support
 359           python-version: "3.8"
 360       - name: Install Requirements
 361         run: | # Custom pyinstaller built with https://github.com/yt-dlp/pyinstaller-builds
 362           python devscripts/install_deps.py -o --include build
 363           python devscripts/install_deps.py --include py2exe --include curl-cffi
 364           python -m pip install -U "https://yt-dlp.github.io/Pyinstaller-Builds/x86_64/pyinstaller-5.8.0-py3-none-any.whl"
 365
 366       - name: Prepare
 367         run: |
 368           python devscripts/update-version.py -c "${{ inputs.channel }}" -r "${{ needs.process.outputs.origin }}" "${{ inputs.version }}"
 369           python devscripts/make_lazy_extractors.py
 370       - name: Build
 371         run: |
 372           python -m bundle.py2exe
 373           Move-Item ./dist/yt-dlp.exe ./dist/yt-dlp_min.exe
 374           python -m bundle.pyinstaller
 375           python -m bundle.pyinstaller --onedir
 376           Compress-Archive -Path ./dist/yt-dlp/* -DestinationPath ./dist/yt-dlp_win.zip
 377
 378       - name: Verify --update-to
 379         if: vars.UPDATE_TO_VERIFICATION
 380         run: |
 381           foreach ($name in @("yt-dlp","yt-dlp_min")) {
 382             Copy-Item "./dist/${name}.exe" "./dist/${name}_downgraded.exe"
 383             $version = & "./dist/${name}.exe" --version
 384             & "./dist/${name}_downgraded.exe" -v --update-to yt-dlp/yt-dlp@2023.03.04
 385             $downgraded_version = & "./dist/${name}_downgraded.exe" --version
 386             if ($version -eq $downgraded_version) {
 387               exit 1
 388             }
 389           }
 390
 391       - name: Upload artifacts
 392         uses: actions/upload-artifact@v4
 393         with:
 394           name: build-bin-${{ github.job }}
 395           path: |
 396             dist/yt-dlp.exe
 397             dist/yt-dlp_min.exe
 398             dist/yt-dlp_win.zip
 399           compression-level: 0
 400
 401   windows32:
 402     needs: process
 403     if: inputs.windows32
 404     runs-on: windows-latest
 405
 406     steps:
 407       - uses: actions/checkout@v4
 408       - uses: actions/setup-python@v5
 409         with:
 410           python-version: "3.8"
 411           architecture: "x86"
 412       - name: Install Requirements
 413         run: |
 414           python devscripts/install_deps.py -o --include build
 415           python devscripts/install_deps.py
 416           python -m pip install -U "https://yt-dlp.github.io/Pyinstaller-Builds/i686/pyinstaller-5.8.0-py3-none-any.whl"
 417
 418       - name: Prepare
 419         run: |
 420           python devscripts/update-version.py -c "${{ inputs.channel }}" -r "${{ needs.process.outputs.origin }}" "${{ inputs.version }}"
 421           python devscripts/make_lazy_extractors.py
 422       - name: Build
 423         run: |
 424           python -m bundle.pyinstaller
 425
 426       - name: Verify --update-to
 427         if: vars.UPDATE_TO_VERIFICATION
 428         run: |
 429           foreach ($name in @("yt-dlp_x86")) {
 430             Copy-Item "./dist/${name}.exe" "./dist/${name}_downgraded.exe"
 431             $version = & "./dist/${name}.exe" --version
 432             & "./dist/${name}_downgraded.exe" -v --update-to yt-dlp/yt-dlp@2023.03.04
 433             $downgraded_version = & "./dist/${name}_downgraded.exe" --version
 434             if ($version -eq $downgraded_version) {
 435               exit 1
 436             }
 437           }
 438
 439       - name: Upload artifacts
 440         uses: actions/upload-artifact@v4
 441         with:
 442           name: build-bin-${{ github.job }}
 443           path: |
 444             dist/yt-dlp_x86.exe
 445           compression-level: 0
 446
 447   meta_files:
 448     if: always() && !cancelled()
 449     needs:
 450       - process
 451       - unix
 452       - linux_static
 453       - linux_arm
 454       - macos
 455       - macos_legacy
 456       - windows
 457       - windows32
 458     runs-on: ubuntu-latest
 459     steps:
 460       - uses: actions/download-artifact@v4
 461         with:
 462           path: artifact
 463           pattern: build-bin-*
 464           merge-multiple: true
 465
 466       - name: Make SHA2-SUMS files
 467         run: |
 468           cd ./artifact/
 469           # make sure SHA sums are also printed to stdout
 470           sha256sum * | tee ../SHA2-256SUMS
 471           sha512sum * | tee ../SHA2-512SUMS
 472
 473       - name: Make Update spec
 474         run: |
 475           cat >> _update_spec << EOF
 476           # This file is used for regulating self-update
 477           lock 2022.08.18.36 .+ Python 3\.6
 478           lock 2023.11.16 (?!win_x86_exe).+ Python 3\.7
 479           lock 2023.11.16 win_x86_exe .+ Windows-(?:Vista|2008Server)
 480           lockV2 yt-dlp/yt-dlp 2022.08.18.36 .+ Python 3\.6
 481           lockV2 yt-dlp/yt-dlp 2023.11.16 (?!win_x86_exe).+ Python 3\.7
 482           lockV2 yt-dlp/yt-dlp 2023.11.16 win_x86_exe .+ Windows-(?:Vista|2008Server)
 483           lockV2 yt-dlp/yt-dlp-nightly-builds 2023.11.15.232826 (?!win_x86_exe).+ Python 3\.7
 484           lockV2 yt-dlp/yt-dlp-nightly-builds 2023.11.15.232826 win_x86_exe .+ Windows-(?:Vista|2008Server)
 485           lockV2 yt-dlp/yt-dlp-master-builds 2023.11.15.232812 (?!win_x86_exe).+ Python 3\.7
 486           lockV2 yt-dlp/yt-dlp-master-builds 2023.11.15.232812 win_x86_exe .+ Windows-(?:Vista|2008Server)
 487           EOF
 488
 489       - name: Sign checksum files
 490         env:
 491           GPG_SIGNING_KEY: ${{ secrets.GPG_SIGNING_KEY }}
 492         if: env.GPG_SIGNING_KEY != ''
 493         run: |
 494           gpg --batch --import <<< "${{ secrets.GPG_SIGNING_KEY }}"
 495           for signfile in ./SHA*SUMS; do
 496             gpg --batch --detach-sign "$signfile"
 497           done
 498
 499       - name: Upload artifacts
 500         uses: actions/upload-artifact@v4
 501         with:
 502           name: build-${{ github.job }}
 503           path: |
 504             _update_spec
 505             SHA*SUMS*
 506           compression-level: 0
 507           overwrite: true