yt-dlp/.github/workflows/build.yml at master · somini/yt-dlp

Repository navigation

View runs

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

on:

workflow_call:

inputs:

version:

required: true

type: string

channel:

required: false

default: stable

type: string

unix:

default: true

type: boolean

linux_static:

default: true

type: boolean

linux_arm:

default: true

type: boolean

macos:

default: true

type: boolean

macos_legacy:

default: true

type: boolean

windows:

default: true

type: boolean

windows32:

default: true

type: boolean

origin:

required: false

default: ''

type: string

secrets:

GPG_SIGNING_KEY:

required: false

workflow_dispatch:

inputs:

version:

description: |

VERSION: yyyy.mm.dd[.rev] or rev

required: true

type: string

channel:

description: |

SOURCE of this build's updates: stable/nightly/master/<repo>

required: true

default: stable

type: string

unix:

description: yt-dlp, yt-dlp.tar.gz

default: true

type: boolean

linux_static:

description: yt-dlp_linux

default: true

type: boolean

linux_arm:

description: yt-dlp_linux_aarch64, yt-dlp_linux_armv7l

default: true

type: boolean

macos:

description: yt-dlp_macos, yt-dlp_macos.zip

default: true

type: boolean

macos_legacy:

description: yt-dlp_macos_legacy

default: true

type: boolean

windows:

description: yt-dlp.exe, yt-dlp_min.exe, yt-dlp_win.zip

default: true

type: boolean

windows32:

description: yt-dlp_x86.exe

default: true

type: boolean

origin:

description: Origin

required: false

default: 'current repo'

type: choice

options:

- 'current repo'

permissions:

contents: read

jobs:

process:

runs-on: ubuntu-latest

outputs:

origin: ${{ steps.process_origin.outputs.origin }}

steps:

- name: Process origin

id: process_origin

run: |

echo "origin=${{ inputs.origin == 'current repo' && github.repository || inputs.origin }}" | tee "$GITHUB_OUTPUT"

unix:

needs: process

if: inputs.unix

runs-on: ubuntu-latest

steps:

- uses: actions/checkout@v4

with:

fetch-depth: 0 # Needed for changelog

- uses: actions/setup-python@v5

with:

python-version: "3.10"

- name: Install Requirements

run: |

sudo apt -y install zip pandoc man sed

- name: Prepare

run: |

python devscripts/update-version.py -c "${{ inputs.channel }}" -r "${{ needs.process.outputs.origin }}" "${{ inputs.version }}"

python devscripts/update_changelog.py -vv

python devscripts/make_lazy_extractors.py

- name: Build Unix platform-independent binary

run: |

make all tar

- name: Verify --update-to

if: vars.UPDATE_TO_VERIFICATION

run: |

chmod +x ./yt-dlp

cp ./yt-dlp ./yt-dlp_downgraded

version="$(./yt-dlp --version)"

./yt-dlp_downgraded -v --update-to yt-dlp/yt-dlp@2023.03.04

downgraded_version="$(./yt-dlp_downgraded --version)"

[[ "$version" != "$downgraded_version" ]]

- name: Upload artifacts

uses: actions/upload-artifact@v4

with:

path: |

yt-dlp

yt-dlp.tar.gz

compression-level: 0

linux_static:

needs: process

if: inputs.linux_static

runs-on: ubuntu-latest

steps:

- uses: actions/checkout@v4

- name: Build static executable

env:

channel: ${{ inputs.channel }}

origin: ${{ needs.process.outputs.origin }}

version: ${{ inputs.version }}

run: |

mkdir ~/build

cd bundle/docker

docker compose up --build static

sudo chown "${USER}:docker" ~/build/yt-dlp_linux

- name: Verify --update-to

if: vars.UPDATE_TO_VERIFICATION

run: |

chmod +x ~/build/yt-dlp_linux

cp ~/build/yt-dlp_linux ~/build/yt-dlp_linux_downgraded

version="$(~/build/yt-dlp_linux --version)"

~/build/yt-dlp_linux_downgraded -v --update-to yt-dlp/yt-dlp@2023.03.04

downgraded_version="$(~/build/yt-dlp_linux_downgraded --version)"

[[ "$version" != "$downgraded_version" ]]

- name: Upload artifacts

uses: actions/upload-artifact@v4

with:

path: |

~/build/yt-dlp_linux

compression-level: 0

linux_arm:

needs: process

if: inputs.linux_arm

permissions:

contents: read

packages: write # for creating cache

runs-on: ubuntu-latest

strategy:

matrix:

architecture:

- armv7

- aarch64

steps:

- uses: actions/checkout@v4

with:

path: ./repo

- name: Virtualized Install, Prepare & Build

uses: yt-dlp/run-on-arch-action@v2

with:

# Ref: https://github.com/uraimo/run-on-arch-action/issues/55

env: |

GITHUB_WORKFLOW: build

githubToken: ${{ github.token }} # To cache image

arch: ${{ matrix.architecture }}

distro: ubuntu18.04 # Standalone executable should be built on minimum supported OS

dockerRunArgs: --volume "${PWD}/repo:/repo"

install: | # Installing Python 3.10 from the Deadsnakes repo raises errors

apt update

apt -y install zlib1g-dev libffi-dev python3.8 python3.8-dev python3.8-distutils python3-pip

python3.8 -m pip install -U pip setuptools wheel

# Cannot access any files from the repo directory at this stage

python3.8 -m pip install -U Pyinstaller mutagen pycryptodomex websockets brotli certifi secretstorage cffi

run: |

cd repo

python3.8 devscripts/install_deps.py -o --include build

python3.8 devscripts/install_deps.py --include pyinstaller --include secretstorage # Cached version may be out of date

python3.8 devscripts/update-version.py -c "${{ inputs.channel }}" -r "${{ needs.process.outputs.origin }}" "${{ inputs.version }}"

python3.8 devscripts/make_lazy_extr 10BC8 actors.py

python3.8 -m bundle.pyinstaller

if ${{ vars.UPDATE_TO_VERIFICATION && 'true' || 'false' }}; then

arch="${{ (matrix.architecture == 'armv7' && 'armv7l') || matrix.architecture }}"

chmod +x ./dist/yt-dlp_linux_${arch}

cp ./dist/yt-dlp_linux_${arch} ./dist/yt-dlp_linux_${arch}_downgraded

version="$(./dist/yt-dlp_linux_${arch} --version)"

./dist/yt-dlp_linux_${arch}_downgraded -v --update-to yt-dlp/yt-dlp@2023.03.04

downgraded_version="$(./dist/yt-dlp_linux_${arch}_downgraded --version)"

[[ "$version" != "$downgraded_version" ]]

- name: Upload artifacts

uses: actions/upload-artifact@v4

with:

path: | # run-on-arch-action designates armv7l as armv7

repo/dist/yt-dlp_linux_${{ (matrix.architecture == 'armv7' && 'armv7l') || matrix.architecture }}

compression-level: 0

macos:

needs: process

if: inputs.macos

permissions:

contents: read

actions: write # For cleaning up cache

runs-on: macos-12

steps:

- uses: actions/checkout@v4

# NB: Building universal2 does not work with python from actions/setup-python

- name: Restore cached requirements

id: restore-cache

uses: actions/cache/restore@v4

env:

SEGMENT_DOWNLOAD_TIMEOUT_MINS: 1

with:

path: |

~/yt-dlp-build-venv

key: cache-reqs-${{ github.job }}

- name: Install Requirements

run: |

brew install coreutils

python3 -m venv ~/yt-dlp-build-venv

source ~/yt-dlp-build-venv/bin/activate

python3 devscripts/install_deps.py -o --include build

python3 devscripts/install_deps.py --print --include pyinstaller > requirements.txt

# We need to ignore wheels otherwise we break universal2 builds

python3 -m pip install -U --no-binary :all: -r requirements.txt

# We need to fuse our own universal2 wheels for curl_cffi

python3 -m pip install -U delocate

mkdir curl_cffi_whls curl_cffi_universal2

python3 devscripts/install_deps.py --print -o --include curl-cffi > requirements.txt

for platform in "macosx_11_0_arm64" "macosx_11_0_x86_64"; do

python3 -m pip download \

--only-binary=:all: \

--platform "${platform}" \

-d curl_cffi_whls \

-r requirements.txt

done

( # Overwrite x86_64-only libs with fat/universal2 libs or else Pyinstaller will do the opposite

# See https://github.com/yt-dlp/yt-dlp/pull/10069

cd curl_cffi_whls

mkdir -p curl_cffi/.dylibs

python_libdir=$(python3 -c 'import sys; from pathlib import Path; print(Path(sys.path[1]).parent)')

for dylib in lib{ssl,crypto}.3.dylib; do

cp "${python_libdir}/${dylib}" "curl_cffi/.dylibs/${dylib}"

for wheel in curl_cffi*macos*x86_64.whl; do

zip "${wheel}" "curl_cffi/.dylibs/${dylib}"

done

)

python3 -m delocate.cmd.delocate_fuse curl_cffi_whls/curl_cffi*.whl -w curl_cffi_universal2

python3 -m delocate.cmd.delocate_fuse curl_cffi_whls/cffi*.whl -w curl_cffi_universal2

for wheel in curl_cffi_universal2/*cffi*.whl; do

mv -n -- "${wheel}" "${wheel/x86_64/universal2}"

done

python3 -m pip install --force-reinstall -U curl_cffi_universal2/*cffi*.whl

- name: Prepare

run: |

python3 devscripts/update-version.py -c "${{ inputs.channel }}" -r "${{ needs.process.outputs.origin }}" "${{ inputs.version }}"

python3 devscripts/make_lazy_extractors.py

- name: Build

run: |

source ~/yt-dlp-build-venv/bin/activate

python3 -m bundle.pyinstaller --target-architecture universal2 --onedir

(cd ./dist/yt-dlp_macos && zip -r ../yt-dlp_macos.zip .)

python3 -m bundle.pyinstaller --target-architecture universal2

- name: Verify --update-to

if: vars.UPDATE_TO_VERIFICATION

run: |

chmod +x ./dist/yt-dlp_macos

cp ./dist/yt-dlp_macos ./dist/yt-dlp_macos_downgraded

version="$(./dist/yt-dlp_macos --version)"

./dist/yt-dlp_macos_downgraded -v --update-to yt-dlp/yt-dlp@2023.03.04

downgraded_version="$(./dist/yt-dlp_macos_downgraded --version)"

[[ "$version" != "$downgraded_version" ]]

- name: Upload artifacts

uses: actions/upload-artifact@v4

with:

path: |

dist/yt-dlp_macos

dist/yt-dlp_macos.zip

compression-level: 0

- name: Cleanup cache

if: steps.restore-cache.outputs.cache-hit == 'true'

env:

GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

cache_key: cache-reqs-${{ github.job }}

repository: ${{ github.repository }}

branch: ${{ github.ref }}

run: |

gh extension install actions/gh-actions-cache

gh actions-cache delete "${cache_key}" -R "${repository}" -B "${branch}" --confirm

- name: Cache requirements

uses: actions/cache/save@v4

with:

path: |

~/yt-dlp-build-venv

key: cache-reqs-${{ github.job }}

macos_legacy:

needs: process

if: inputs.macos_legacy

runs-on: macos-12

steps:

- uses: actions/checkout@v4

- name: Install Python

# We need the official Python, because the GA ones only support newer macOS versions

env:

PYTHON_VERSION: 3.10.5

MACOSX_DEPLOYMENT_TARGET: 10.9 # Used up by the Python build tools

run: |

# Hack to get the latest patch version. Uncomment if needed

#brew install python@3.10

#export PYTHON_VERSION=$( $(brew --prefix)/opt/python@3.10/bin/python3 --version | cut -d ' ' -f 2 )

curl "https://www.python.org/ftp/python/${PYTHON_VERSION}/python-${PYTHON_VERSION}-macos11.pkg" -o "python.pkg"

sudo installer -pkg python.pkg -target /

python3 --version

- name: Install Requirements

run: |

brew install coreutils

python3 devscripts/install_deps.py --user -o --include build

python3 devscripts/install_deps.py --user --include pyinstaller

- name: Prepare

run: |

python3 devscripts/update-version.py -c "${{ inputs.channel }}" -r "${{ needs.process.outputs.origin }}" "${{ inputs.version }}"

python3 devscripts/make_lazy_extractors.py

- name: Build

run: |

python3 -m bundle.pyinstaller

mv dist/yt-dlp_macos dist/yt-dlp_macos_legacy

- name: Verify --update-to

if: vars.UPDATE_TO_VERIFICATION

run: |

chmod +x ./dist/yt-dlp_macos_legacy

cp ./dist/yt-dlp_macos_legacy ./dist/yt-dlp_macos_legacy_downgraded

version="$(./dist/yt-dlp_macos_legacy --version)"

./dist/yt-dlp_macos_legacy_downgraded -v --update-to yt-dlp/yt-dlp@2023.03.04

downgraded_version="$(./dist/yt-dlp_macos_legacy_downgraded --version)"

[[ "$version" != "$downgraded_version" ]]

- name: Upload artifacts

uses: actions/upload-artifact@v4

with:

path: |

dist/yt-dlp_macos_legacy

compression-level: 0

windows:

needs: process

if: inputs.windows

runs-on: windows-latest

steps:

- uses: actions/checkout@v4

- uses: actions/setup-python@v5

with: # 3.8 is used for Win7 support

python-version: "3.8"

- name: Install Requirements

run: | # Custom pyinstaller built with https://github.com/yt-dlp/pyinstaller-builds

python devscripts/install_deps.py -o --include build

python devscripts/install_deps.py --include curl-cffi

python -m pip install -U "https://yt-dlp.github.io/Pyinstaller-Builds/x86_64/pyinstaller-6.7.0-py3-none-any.whl"

- name: Prepare

run: |

python devscripts/update-version.py -c "${{ inputs.channel }}" -r "${{ needs.process.outputs.origin }}" "${{ inputs.version }}"

python devscripts/make_lazy_extractors.py

- name: Build

run: |

python -m bundle.pyinstaller

python -m bundle.pyinstaller --onedir

Move-Item ./dist/yt-dlp.exe ./dist/yt-dlp_real.exe

Compress-Archive -Path ./dist/yt-dlp/* -DestinationPath ./dist/yt-dlp_win.zip

- name: Install Requirements (py2exe)

run: |

python devscripts/install_deps.py --include py2exe

- name: Build (py2exe)

run: |

python -m bundle.py2exe

Move-Item ./dist/yt-dlp.exe ./dist/yt-dlp_min.exe

Move-Item ./dist/yt-dlp_real.exe ./dist/yt-dlp.exe

- name: Verify --update-to

if: vars.UPDATE_TO_VERIFICATION

run: |

foreach ($name in @("yt-dlp","yt-dlp_min")) {

Copy-Item "./dist/${name}.exe" "./dist/${name}_downgraded.exe"

$version = & "./dist/${name}.exe" --version

& "./dist/${name}_downgraded.exe" -v --update-to yt-dlp/yt-dlp@2023.03.04

$downgraded_version = & "./dist/${name}_downgraded.exe" --version

if ($version -eq $downgraded_version) {

exit 1

}

- name: Upload artifacts

uses: actions/upload-artifact@v4

with:

path: |

dist/yt-dlp.exe

dist/yt-dlp_min.exe

dist/yt-dlp_win.zip

compression-level: 0

windows32:

needs: process

if: inputs.windows32

runs-on: windows-latest

steps:

- uses: actions/checkout@v4

- uses: actions/setup-python@v5

with:

python-version: "3.8"

architecture: "x86"

- name: Install Requirements

run: |

python devscripts/install_deps.py -o --include build

python devscripts/install_deps.py

python -m pip install -U "https://yt-dlp.github.io/Pyinstaller-Builds/i686/pyinstaller-6.7.0-py3-none-any.whl"

- name: Prepare

run: |

python devscripts/update-version.py -c "${{ inputs.channel }}" -r "${{ needs.process.outputs.origin }}" "${{ inputs.version }}"

python devscripts/make_lazy_extractors.py

- name: Build

run: |

python -m bundle.pyinstaller

- name: Verify --update-to

if: vars.UPDATE_TO_VERIFICATION

run: |

foreach ($name in @("yt-dlp_x86")) {

Copy-Item "./dist/${name}.exe" "./dist/${name}_downgraded.exe"

$version = & "./dist/${name}.exe" --version

& "./dist/${name}_downgraded.exe" -v --update-to yt-dlp/yt-dlp@2023.03.04

$downgraded_version = & "./dist/${name}_downgraded.exe" --version

if ($version -eq $downgraded_version) {

exit 1

}

- name: Upload artifacts

uses: actions/upload-artifact@v4

with:

path: |

dist/yt-dlp_x86.exe

compression-level: 0

meta_files:

if: always() && !cancelled()

needs:

- process

- unix

- linux_static

- linux_arm

- macos

- macos_legacy

- windows

- windows32

runs-on: ubuntu-latest

steps:

- uses: actions/download-artifact@v4

with:

path: artifact

pattern: build-bin-*

merge-multiple: true

- name: Make SHA2-SUMS files

run: |

cd ./artifact/

# make sure SHA sums are also printed to stdout

sha256sum -- * | tee ../SHA2-256SUMS

sha512sum -- * | tee ../SHA2-512SUMS

# also print as permanent annotations to the summary page

while read -r shasum; do

echo "::notice title=${shasum##* }::sha256: ${shasum% *}"

done < ../SHA2-256SUMS

- name: Make Update spec

run: |

cat >> _update_spec << EOF

# This file is used for regulating self-update

lock 2022.08.18.36 .+ Python 3\.6

lock 2023.11.16 (?!win_x86_exe).+ Python 3\.7

lock 2023.11.16 win_x86_exe .+ Windows-(?:Vista|2008Server)

lockV2 yt-dlp/yt-dlp 2022.08.18.36 .+ Python 3\.6

lockV2 yt-dlp/yt-dlp 2023.11.16 (?!win_x86_exe).+ Python 3\.7

lockV2 yt-dlp/yt-dlp 2023.11.16 win_x86_exe .+ Windows-(?:Vista|2008Server)

lockV2 yt-dlp/yt-dlp-nightly-builds 2023.11.15.232826 (?!win_x86_exe).+ Python 3\.7

lockV2 yt-dlp/yt-dlp-nightly-builds 2023.11.15.232826 win_x86_exe .+ Windows-(?:Vista|2008Server)

lockV2 yt-dlp/yt-dlp-master-builds 2023.11.15.232812 (?!win_x86_exe).+ Python 3\.7

lockV2 yt-dlp/yt-dlp-master-builds 2023.11.15.232812 win_x86_exe .+ Windows-(?:Vista|2008Server)

EOF

- name: Sign checksum files

env:

GPG_SIGNING_KEY: ${{ secrets.GPG_SIGNING_KEY }}

if: env.GPG_SIGNING_KEY != ''

run: |

gpg --batch --import <<< "${{ secrets.GPG_SIGNING_KEY }}"

for signfile in ./SHA*SUMS; do

gpg --batch --detach-sign "$signfile"

done

- name: Upload artifacts

uses: actions/upload-artifact@v4

with:

path: |

_update_spec

SHA*SUMS*

compression-level: 0

overwrite: true

FilesExpand file tree

build.yml

Latest commit

History

build.yml

File metadata and controls