[build] Automated builds and nightly releases (yt-dlp#6220)

Closes yt-dlp#1839
Authored by: Grub4K, bashonly

Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>

.github/workflows/publish.yml

@@ -0,0 +1,80 @@
+name: Publish
+on:
+  workflow_call:
+    inputs:
+      nightly:
+        default: false
+        required: false
+        type: boolean
+      version:
+        required: true
+        type: string
+      target_commitish:
+        required: true
+        type: string
+    secrets:
+      ARCHIVE_REPO_TOKEN:
+        required: false
+
+permissions:
+  contents: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/download-artifact@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Generate release notes
+        run: |
+          cat >> ./RELEASE_NOTES << EOF
+          #### A description of the various files are in the [README](https://github.com/yt-dlp/yt-dlp#release-files)
+          ---
+          <details><summary><h3>Changelog</h3></summary>
+          $(python ./devscripts/make_changelog.py -vv)
+          </details>
+          EOF
+          echo "**This is an automated nightly pre-release build**" >> ./PRERELEASE_NOTES
+          cat ./RELEASE_NOTES >> ./PRERELEASE_NOTES
+          echo "Generated from: https://github.com/${{ github.repository }}/commit/${{ inputs.target_commitish }}" >> ./ARCHIVE_NOTES
+          cat ./RELEASE_NOTES >> ./ARCHIVE_NOTES
+
+      - name: Archive nightly release
+        env:
+          GH_TOKEN: ${{ secrets.ARCHIVE_REPO_TOKEN }}
+          GH_REPO: ${{ vars.ARCHIVE_REPO }}
+        if: |
+          inputs.nightly && env.GH_TOKEN != '' && env.GH_REPO != ''
+        run: |
+          gh release create \
+            --notes-file ARCHIVE_NOTES \
+            --title "Build ${{ inputs.version }}" \
+            ${{ inputs.version }} \
+            artifact/*
+
+      - name: Prune old nightly release
+        if: inputs.nightly
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh release delete --yes --cleanup-tag "nightly" || true
+          git tag --delete "nightly" || true
+          sleep 5  # Enough time to cover deletion race condition
+
+      - name: Publish release${{ inputs.nightly && ' (nightly)' || '' }}
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh release create \
+            --notes-file ${{ inputs.nightly && 'PRE' || '' }}RELEASE_NOTES \
+            --target ${{ inputs.target_commitish }} \
+            --title "yt-dlp ${{ inputs.nightly && 'nightly ' || '' }}${{ inputs.version }}" \
+            ${{ inputs.nightly && '--prerelease "nightly"' || inputs.version }} \
+            artifact/*

.github/workflows/release-nightly.yml

@@ -0,0 +1,49 @@
+name: Release (nightly)
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - "**.py"
+      - "!yt_dlp/version.py"
+concurrency:
+  group: release-nightly
+  cancel-in-progress: true
+permissions:
+  contents: read
+
+jobs:
+  prepare:
+    if: vars.BUILD_NIGHTLY != ''
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.get_version.outputs.version }}
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Get version
+        id: get_version
+        run: |
+          python devscripts/update-version.py "$(date -u +"%H%M%S")" | grep -Po "version=\d+(\.\d+){3}" >> "$GITHUB_OUTPUT"
+
+  build:
+    needs: prepare
+    uses: ./.github/workflows/build.yml
+    with:
+      version: ${{ needs.prepare.outputs.version }}
+      channel: nightly
+    permissions:
+      contents: read
+      packages: write # For package cache
+
+  publish:
+    needs: [prepare, build]
+    uses: ./.github/workflows/publish.yml
+    secrets:
+      ARCHIVE_REPO_TOKEN: ${{ secrets.ARCHIVE_REPO_TOKEN }}
+    permissions:
+      contents: write
+    with:
+      nightly: true
+      version: ${{ needs.prepare.outputs.version }}
+      target_commitish: ${{ github.sha }}

.github/workflows/release.yml

@@ -0,0 +1,125 @@
+name: Release
+on: workflow_dispatch
+permissions:
+  contents: read
+
+jobs:
+  prepare:
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.update_version.outputs.version }}
+      head_sha: ${{ steps.push_release.outputs.head_sha }}
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Update version
+        id: update_version
+        run: |
+          python devscripts/update-version.py ${{ vars.PUSH_VERSION_COMMIT == '' && '"$(date -u +"%H%M%S")"' || '' }} | \
+            grep -Po "version=\d+\.\d+\.\d+(\.\d+)?" >> "$GITHUB_OUTPUT"
+
+      - name: Update documentation
+        run: |
+          make doc
+          sed '/### /Q' Changelog.md >> ./CHANGELOG
+          echo '### ${{ steps.update_version.outputs.version }}' >> ./CHANGELOG
+          python ./devscripts/make_changelog.py -vv -c >> ./CHANGELOG
+          echo >> ./CHANGELOG
+          grep -Poz '(?s)### \d+\.\d+\.\d+.+' 'Changelog.md' | head -n -1 >> ./CHANGELOG
+          cat ./CHANGELOG > Changelog.md
+
+      - name: Push to release
+        id: push_release
+        run: |
+          git config --global user.name github-actions
+          git config --global user.email github-actions@example.com
+          git add -u
+          git commit -m "Release ${{ steps.update_version.outputs.version }}" \
+            -m "Created by: ${{ github.event.sender.login }}" -m ":ci skip all :ci run dl"
+          git push origin --force ${{ github.event.ref }}:release
+          echo "head_sha=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT"
+
+      - name: Update master
+        if: vars.PUSH_VERSION_COMMIT != ''
+        run: git push origin ${{ github.event.ref }}
+
+  publish_pypi_homebrew:
+    needs: prepare
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install Requirements
+        run: |
+          python -m pip install -U pip setuptools wheel twine
+          python -m pip install -U -r requirements.txt
+
+      - name: Prepare
+        run: |
+          python devscripts/update-version.py ${{ needs.prepare.outputs.version }}
+          python devscripts/make_lazy_extractors.py
+
+      - name: Build and publish on PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        if: env.TWINE_PASSWORD != ''
+        run: |
+          rm -rf dist/*
+          python devscripts/set-variant.py pip -M "You installed yt-dlp with pip or using the wheel from PyPi; Use that to update"
+          python setup.py sdist bdist_wheel
+          twine upload dist/*
+
+      - name: Checkout Homebrew repository
+        env:
+          BREW_TOKEN: ${{ secrets.BREW_TOKEN }}
+          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        if: env.BREW_TOKEN != '' && env.PYPI_TOKEN != ''
+        uses: actions/checkout@v3
+        with:
+          repository: yt-dlp/homebrew-taps
+          path: taps
+          ssh-key: ${{ secrets.BREW_TOKEN }}
+
+      - name: Update Homebrew Formulae
+        env:
+          BREW_TOKEN: ${{ secrets.BREW_TOKEN }}
+          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        if: env.BREW_TOKEN != '' && env.PYPI_TOKEN != ''
+        run: |
+          python devscripts/update-formulae.py taps/Formula/yt-dlp.rb "${{ needs.prepare.outputs.version }}"
+          git -C taps/ config user.name github-actions
+          git -C taps/ config user.email github-actions@example.com
+          git -C taps/ commit -am 'yt-dlp: ${{ needs.prepare.outputs.version }}'
+          git -C taps/ push
+
+  build:
+    needs: prepare
+    uses: ./.github/workflows/build.yml
+    with:
+      version: ${{ needs.prepare.outputs.version }}
+    permissions:
+      contents: read
+      packages: write # For package cache
+
+  publish:
+    needs: [prepare, build]
+    uses: ./.github/workflows/publish.yml
+    permissions:
+      contents: write
+    with:
+      version: ${{ needs.prepare.outputs.version }}
+      target_commitish: ${{ needs.prepare.outputs.head_sha }}

Changelog.md

@@ -1,13 +1,7 @@
 # Changelog
 
 <!--
-# Instuctions for creating release
-
-* Run `make doc`
-* Update Changelog.md and CONTRIBUTORS
-* Change "Based on ytdl" version in Readme.md if needed
-* Commit as `Release <version>` and push to master
-* Dispatch the workflow https://github.com/yt-dlp/yt-dlp/actions/workflows/build.yml on master
+# To create a release, dispatch the https://github.com/yt-dlp/yt-dlp/actions/workflows/release.yml workflow on master
 -->
 
 ### 2023.02.17

README.md

@@ -318,7 +318,8 @@ If you wish to build it anyway, install Python and py2exe, and then simply run `
 
 Note: See their `--help` for more info.
 
-You can also fork the project on GitHub and run your fork's [build workflow](.github/workflows/build.yml) to automatically build a full release
+### Forking the project
+If you fork the project on GitHub, you can run your fork's [build workflow](.github/workflows/build.yml) to automatically build the selected version(s) as artifacts. Alternatively, you can run the [release workflow](.github/workflows/release.yml) or enable the [nightly workflow](.github/workflows/release-nightly.yml) to create full (pre-)releases.
 
 # USAGE AND OPTIONS
 
@@ -460,9 +461,8 @@ You can also fork the project on GitHub and run your fork's [build workflow](.gi
     --date DATE                     Download only videos uploaded on this date.
                                     The date can be "YYYYMMDD" or in the format 
                                     [now|today|yesterday][-N[day|week|month|year]].
-                                    E.g. "--date today-2weeks" downloads
-                                    only videos uploaded on the same day two
-                                    weeks ago
+                                    E.g. "--date today-2weeks" downloads only
+                                    videos uploaded on the same day two weeks ago
     --datebefore DATE               Download only videos uploaded on or before
                                     this date. The date formats accepted is the
                                     same as --date

devscripts/make_readme.py

@@ -45,33 +45,43 @@ def apply_patch(text, patch):
 delim = f'\n{" " * switch_col_width}'
 
 PATCHES = (
-    (   # Standardize update message
+    (   # Standardize `--update` message
         r'(?m)^(    -U, --update\s+).+(\n    \s.+)*$',
         r'\1Update this program to the latest version',
     ),
-    (  # Headings
+    (   # Headings
         r'(?m)^  (\w.+\n)(    (?=\w))?',
         r'## \1'
     ),
-    (  # Do not split URLs
+    (   # Fixup `--date` formatting
+        rf'(?m)(    --date DATE.+({delim}[^\[]+)*)\[.+({delim}.+)*$',
+        (rf'\1[now|today|yesterday][-N[day|week|month|year]].{delim}'
+         f'E.g. "--date today-2weeks" downloads only{delim}'
+         'videos uploaded on the same day two weeks ago'),
+    ),
+    (   # Do not split URLs
         rf'({delim[:-1]})? (?P<label>\[\S+\] )?(?P<url>https?({delim})?:({delim})?/({delim})?/(({delim})?\S+)+)\s',
         lambda mobj: ''.join((delim, mobj.group('label') or '', re.sub(r'\s+', '', mobj.group('url')), '\n'))
     ),
-    (  # Do not split "words"
+    (   # Do not split "words"
         rf'(?m)({delim}\S+)+$',
         lambda mobj: ''.join((delim, mobj.group(0).replace(delim, '')))
     ),
-    (  # Allow overshooting last line
+    (   # Allow overshooting last line
         rf'(?m)^(?P<prev>.+)${delim}(?P<current>.+)$(?!{delim})',
         lambda mobj: (mobj.group().replace(delim, ' ')
                       if len(mobj.group()) - len(delim) + 1 <= max_width + ALLOWED_OVERSHOOT
                       else mobj.group())
     ),
-    (  # Avoid newline when a space is available b/w switch and description
+    (   # Avoid newline when a space is available b/w switch and description
         DISABLE_PATCH,  # This creates issues with prepare_manpage
         r'(?m)^(\s{4}-.{%d})(%s)' % (switch_col_width - 6, delim),
         r'\1 '
     ),
+    (   # Replace brackets with a Markdown link
+        r'SponsorBlock API \((http.+)\)',
+        r'[SponsorBlock API](\1)'
+    ),
 )
 
 readme = read_file(README_FILE)