From 11bb420f192f45f86929751307db73e2c2289b8e Mon Sep 17 00:00:00 2001 From: DARKZOUL5 Date: Tue, 17 Mar 2026 15:25:42 +0200 Subject: [PATCH] Fix workflow with gitub specific features after migration from gitea; create project plan --- .gitea/workflows/release.yml | 218 ------------ {.gitea => .github}/workflows/integration.yml | 0 .github/workflows/release.yml | 322 ++++++++++++++++++ {.gitea => .github}/workflows/unit-tests.yml | 0 project plan.md | 49 +++ 5 files changed, 371 insertions(+), 218 deletions(-) delete mode 100644 .gitea/workflows/release.yml rename {.gitea => .github}/workflows/integration.yml (100%) create mode 100644 .github/workflows/release.yml rename {.gitea => .github}/workflows/unit-tests.yml (100%) create mode 100644 project plan.md diff --git a/.gitea/workflows/release.yml b/.gitea/workflows/release.yml deleted file mode 100644 index 79c87bd..0000000 --- a/.gitea/workflows/release.yml +++ /dev/null @@ -1,218 +0,0 @@ -name: Build Release Packages - -on: - push: - tags: - - "v*.*.*" - -jobs: - build-windows-package: - runs-on: ubuntu-latest - steps: - - name: Checkout code - uses: https://gitea.com/actions/checkout@v5 - - - name: Install dependencies - run: | - sudo apt update - sudo apt install -y unzip zip curl - - - name: Extract tag name - run: | - REF="${GITEA_REF:-$GITHUB_REF}" - TAG="${REF#refs/tags/}" - echo "TAG=$TAG" >> $GITHUB_ENV - - - name: Prepare Windows package - run: | - set -e - WORKSPACE_ROOT="${GITEA_WORKSPACE:-$PWD}" - mkdir -p "$WORKSPACE_ROOT/dist/windows" - cp "$WORKSPACE_ROOT/yt-playlist-main.py" "$WORKSPACE_ROOT/dist/windows/" - cp -r "$WORKSPACE_ROOT/ytplaylist" "$WORKSPACE_ROOT/dist/windows/" - cp -r "$WORKSPACE_ROOT/config" "$WORKSPACE_ROOT/dist/windows/" - - mkdir -p "$WORKSPACE_ROOT/dist/windows/bin" - - # yt-dlp - curl -L -o "$WORKSPACE_ROOT/dist/windows/bin/yt-dlp.exe" https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe - - # FFmpeg Windows static - curl -L -o "$WORKSPACE_ROOT/dist/windows/ffmpeg.zip" https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-essentials.zip - unzip -q "$WORKSPACE_ROOT/dist/windows/ffmpeg.zip" -d "$WORKSPACE_ROOT/dist/windows/ffmpeg_temp" - mv $(find "$WORKSPACE_ROOT/dist/windows/ffmpeg_temp" -name ffmpeg.exe | head -n 1) "$WORKSPACE_ROOT/dist/windows/bin/ffmpeg.exe" - - # aria2c Windows static - curl -L -o "$WORKSPACE_ROOT/dist/windows/aria2c.zip" https://github.com/aria2/aria2/releases/download/release-1.37.0/aria2-1.37.0-win-64bit-build1.zip - unzip "$WORKSPACE_ROOT/dist/windows/aria2c.zip" -d "$WORKSPACE_ROOT/dist/windows/" - mv "$WORKSPACE_ROOT/dist/windows/aria2-1.37.0-win-64bit-build1/aria2c.exe" "$WORKSPACE_ROOT/dist/windows/bin/aria2c.exe" - - # Remove temp files before zipping - rm -rf "$WORKSPACE_ROOT/dist/windows/ffmpeg_temp" "$WORKSPACE_ROOT/dist/windows/aria2-1.37.0-win-64bit-build1" "$WORKSPACE_ROOT/dist/windows/ffmpeg.zip" "$WORKSPACE_ROOT/dist/windows/aria2c.zip" - - cd "$WORKSPACE_ROOT/dist/windows" - ZIP_NAME="yt-playlist-windows-${TAG}.zip" - zip -r "$WORKSPACE_ROOT/$ZIP_NAME" * - echo "ZIP_PATH=$WORKSPACE_ROOT/$ZIP_NAME" >> $GITHUB_ENV - - - name: Upload Windows artifact - uses: christopherhx/gitea-upload-artifact@v4 - with: - name: windows-zip - path: ${{ env.ZIP_PATH }} - - - - - - - - - - build-linux-package: - runs-on: ubuntu-latest - steps: - - name: Checkout code - uses: https://gitea.com/actions/checkout@v5 - - - name: Install dependencies - run: | - sudo apt update - sudo apt install -y unzip zip curl wget build-essential \ - pkg-config libssl-dev zlib1g-dev - - - - name: Extract tag name - run: | - REF="${GITEA_REF:-$GITHUB_REF}" - TAG="${REF#refs/tags/}" - echo "TAG=$TAG" >> $GITHUB_ENV - - - name: Prepare Linux package - run: | - set -e - WORKSPACE_ROOT="${GITEA_WORKSPACE:-$PWD}" - mkdir -p "$WORKSPACE_ROOT/dist/linux" - cp "$WORKSPACE_ROOT/yt-playlist-main.py" "$WORKSPACE_ROOT/dist/linux/" - cp -r "$WORKSPACE_ROOT/ytplaylist" "$WORKSPACE_ROOT/dist/linux/" - cp -r "$WORKSPACE_ROOT/config" "$WORKSPACE_ROOT/dist/linux/" - - mkdir -p "$WORKSPACE_ROOT/dist/linux/bin" - - # yt-dlp - curl -L -o "$WORKSPACE_ROOT/dist/linux/bin/yt-dlp" https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux - chmod +x "$WORKSPACE_ROOT/dist/linux/bin/yt-dlp" - - # FFmpeg Linux static - curl -L -o "$WORKSPACE_ROOT/dist/linux/ffmpeg.tar.xz" https://johnvansickle.com/ffmpeg/releases/ffmpeg-release-amd64-static.tar.xz - mkdir -p "$WORKSPACE_ROOT/dist/linux/ffmpeg_temp" - tar -xf "$WORKSPACE_ROOT/dist/linux/ffmpeg.tar.xz" -C "$WORKSPACE_ROOT/dist/linux/ffmpeg_temp" --strip-components=1 - mv "$WORKSPACE_ROOT/dist/linux/ffmpeg_temp/ffmpeg" "$WORKSPACE_ROOT/dist/linux/bin/ffmpeg" - chmod +x "$WORKSPACE_ROOT/dist/linux/bin/ffmpeg" - - # aria2c minimal static - mkdir -p "$WORKSPACE_ROOT/dist/linux/aria2c_build" - cd "$WORKSPACE_ROOT" - wget https://github.com/aria2/aria2/releases/download/release-1.37.0/aria2-1.37.0.tar.gz - tar -xzf aria2-1.37.0.tar.gz - cd aria2-1.37.0 - CFLAGS="-Os -s" LDFLAGS="-static" ./configure \ - --enable-static --disable-shared \ - --disable-libaria2 --without-ca-bundle \ - --without-libnettle --without-libgcrypt \ - --without-libssh2 --without-libexpat \ - --without-libxml2 --without-libsqlite3 \ - --with-openssl - make -j"$(nproc)" - strip src/aria2c - - cp src/aria2c "$WORKSPACE_ROOT/dist/linux/bin/aria2c" - chmod +x "$WORKSPACE_ROOT/dist/linux/bin/aria2c" - - # Cleanup - rm -rf "$WORKSPACE_ROOT/dist/linux/ffmpeg_temp" "$WORKSPACE_ROOT/dist/linux/aria2c_build" "$WORKSPACE_ROOT/dist/linux/ffmpeg.tar.xz" "$WORKSPACE_ROOT/aria2-1.37.0" "$WORKSPACE_ROOT/aria2-1.37.0.tar.gz" - - # GZip everything - cd "$WORKSPACE_ROOT/dist/linux" - ZIP_NAME="yt-playlist-linux-${TAG}.tar.gz" - tar -czf "$WORKSPACE_ROOT/$ZIP_NAME" * - echo "ZIP_PATH=$WORKSPACE_ROOT/$ZIP_NAME" >> $GITHUB_ENV - - - name: Upload Linux artifact - uses: christopherhx/gitea-upload-artifact@v4 - with: - name: linux-zip - path: ${{ env.ZIP_PATH }} - - build-docker-image: - runs-on: ubuntu-latest - needs: [build-linux-package, release] - env: - REGISTRY_URL: git.darkzoul.org - REGISTRY_OWNER: dark_zoul - IMAGE_NAME: youtube-playlist-downloader - steps: - - name: Checkout code - uses: https://gitea.com/actions/checkout@v5 - - - name: Extract tag name - run: | - set -e - REF="${GITEA_REF:-$GITHUB_REF}" - TAG="${REF#refs/tags/}" - echo "TAG=$TAG" >> $GITHUB_ENV - - - name: Download linux-zip artifact - uses: christopherhx/gitea-download-artifact@v4 - with: - name: linux-zip - - - name: Extract linux-zip artifact - run: | - set -e - tar -xzf yt-playlist-linux-${TAG}.tar.gz - - - name: Login to the Container registry - uses: https://gitea.com/docker/login-action@v3 - with: - registry: ${{ env.REGISTRY_URL }} - username: ${{ env.REGISTRY_OWNER }} - password: ${{ secrets.MY_REGISTRY_ACCESS_TOKEN }} - - - name: Build Docker image with release tag - run: docker build ./ -t ${{ env.REGISTRY_URL }}/${{ env.REGISTRY_OWNER }}/${{ env.IMAGE_NAME }}:${{ env.TAG }} - - - name: Push Docker image with release tag - run: docker push ${{ env.REGISTRY_URL }}/${{ env.REGISTRY_OWNER }}/${{ env.IMAGE_NAME }}:${{ env.TAG }} - - - name: Build Docker image as latest (distinct digest) - run: docker build ./ --label build_as_latest=true -t ${{ env.REGISTRY_URL }}/${{ env.REGISTRY_OWNER }}/${{ env.IMAGE_NAME }}:latest - - - name: Push Docker image as latest - run: docker push ${{ env.REGISTRY_URL }}/${{ env.REGISTRY_OWNER }}/${{ env.IMAGE_NAME }}:latest - - - - - release: - runs-on: ubuntu-latest - needs: [build-windows-package, build-linux-package] - steps: - - name: Download all artifacts - uses: christopherhx/gitea-download-artifact@v4 - - - name: Extract tag name - run: | - REF="${GITEA_REF:-$GITHUB_REF}" - TAG="${REF#refs/tags/}" - echo "TAG=$TAG" >> $GITHUB_ENV - - - name: Publish release - uses: https://gitea.com/actions/gitea-release-action@v1 - with: - draft: true - tag_name: ${{ env.TAG }} - name: ${{ env.TAG }} - files: | - linux-zip/* - windows-zip/* \ No newline at end of file diff --git a/.gitea/workflows/integration.yml b/.github/workflows/integration.yml similarity index 100% rename from .gitea/workflows/integration.yml rename to .github/workflows/integration.yml diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..d51663f --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,322 @@ +name: Build Release Packages + +on: + workflow_dispatch: + inputs: + tag: + description: "Release tag (e.g., v0.1.0)" + required: true + type: string + +permissions: + contents: write + packages: write + +jobs: + build-windows-package: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v5 + + - name: Install dependencies + run: sudo apt update && sudo apt install -y unzip zip curl + + - name: Get version from tag + id: version + shell: bash + run: | + if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then + VERSION="${{ inputs.tag }}" + elif [ "${{ github.event_name }}" = "release" ]; then + VERSION="${{ github.event.release.tag_name }}" + else + VERSION="${{ github.ref_name }}" + fi + VERSION="${VERSION#v}" + echo "version=$VERSION" >> $GITHUB_OUTPUT + + - name: Prepare Windows package + run: | + set -e + VERSION="${{ steps.version.outputs.version }}" + mkdir -p "$GITHUB_WORKSPACE/dist/windows/bin" + cp "$GITHUB_WORKSPACE/yt-playlist-main.py" "$GITHUB_WORKSPACE/dist/windows/" + + # yt-dlp + curl -fL --retry 3 -H "User-Agent: github-actions" \ + -o "$GITHUB_WORKSPACE/dist/windows/bin/yt-dlp.exe" \ + https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe + + # FFmpeg Windows static + curl -fL --retry 3 -H "User-Agent: github-actions" \ + -o "$GITHUB_WORKSPACE/dist/windows/ffmpeg.zip" \ + https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-essentials.zip + unzip -q "$GITHUB_WORKSPACE/dist/windows/ffmpeg.zip" -d "$GITHUB_WORKSPACE/dist/windows/ffmpeg_temp" + mv $(find "$GITHUB_WORKSPACE/dist/windows/ffmpeg_temp" -name ffmpeg.exe | head -n 1) "$GITHUB_WORKSPACE/dist/windows/bin/ffmpeg.exe" + + # aria2c Windows static + curl -fL --retry 3 -H "User-Agent: github-actions" \ + -o "$GITHUB_WORKSPACE/dist/windows/aria2c.zip" \ + https://github.com/aria2/aria2/releases/download/release-1.37.0/aria2-1.37.0-win-64bit-build1.zip + unzip "$GITHUB_WORKSPACE/dist/windows/aria2c.zip" -d "$GITHUB_WORKSPACE/dist/windows/" + mv "$GITHUB_WORKSPACE/dist/windows/aria2-1.37.0-win-64bit-build1/aria2c.exe" "$GITHUB_WORKSPACE/dist/windows/bin/aria2c.exe" + + rm -rf "$GITHUB_WORKSPACE/dist/windows/ffmpeg_temp" "$GITHUB_WORKSPACE/dist/windows/aria2-1.37.0-win-64bit-build1" "$GITHUB_WORKSPACE/dist/windows/ffmpeg.zip" "$GITHUB_WORKSPACE/dist/windows/aria2c.zip" + + # Create windows archive + cd "$GITHUB_WORKSPACE/dist/windows" + ZIP_NAME="yt-playlist-windows-${VERSION}.zip" + zip -r "$GITHUB_WORKSPACE/$ZIP_NAME" * + echo "ZIP_PATH=$GITHUB_WORKSPACE/$ZIP_NAME" >> $GITHUB_ENV + + - name: Upload Windows artifact + uses: actions/upload-artifact@v4 + with: + name: windows-release + path: ${{ github.workspace }}/yt-playlist-windows-*.zip + + build-linux-package: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v5 + + - name: Get version from tag + id: version + shell: bash + run: | + if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then + VERSION="${{ inputs.tag }}" + elif [ "${{ github.event_name }}" = "release" ]; then + VERSION="${{ github.event.release.tag_name }}" + else + VERSION="${{ github.ref_name }}" + fi + VERSION="${VERSION#v}" + echo "version=$VERSION" >> $GITHUB_OUTPUT + + - name: Install dependencies + run: | + sudo apt update + sudo apt install -y unzip zip curl wget build-essential pkg-config libssl-dev zlib1g-dev + + - name: Prepare workspace + run: | + set -e + mkdir -p "$GITHUB_WORKSPACE/dist/linux/bin" + cp "$GITHUB_WORKSPACE/yt-playlist-main.py" "$GITHUB_WORKSPACE/dist/linux/" + + - name: Download yt-dlp + run: | + curl -fL --retry 3 -H "User-Agent: github-actions" \ + -o "$GITHUB_WORKSPACE/dist/linux/bin/yt-dlp" \ + https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux + chmod +x "$GITHUB_WORKSPACE/dist/linux/bin/yt-dlp" + + - name: Download FFmpeg static + run: | + curl -fL --retry 3 -H "User-Agent: github-actions" \ + -o "$GITHUB_WORKSPACE/dist/linux/ffmpeg.tar.xz" \ + https://johnvansickle.com/ffmpeg/releases/ffmpeg-release-amd64-static.tar.xz + mkdir -p "$GITHUB_WORKSPACE/dist/linux/ffmpeg_temp" + tar -xf "$GITHUB_WORKSPACE/dist/linux/ffmpeg.tar.xz" -C "$GITHUB_WORKSPACE/dist/linux/ffmpeg_temp" --strip-components=1 + mv "$GITHUB_WORKSPACE/dist/linux/ffmpeg_temp/ffmpeg" "$GITHUB_WORKSPACE/dist/linux/bin/ffmpeg" + chmod +x "$GITHUB_WORKSPACE/dist/linux/bin/ffmpeg" + + - name: Restore aria2 cache + id: aria2-cache + uses: actions/cache@v3 + with: + path: dist/linux/bin/aria2c + key: aria2c-${{ runner.os }}-1.37.0 + + - name: Build aria2c if not cached + if: steps.aria2-cache.outputs.cache-hit != 'true' + run: | + set -e + mkdir -p "$GITHUB_WORKSPACE/dist/linux/bin" + + mkdir -p "$GITHUB_WORKSPACE/dist/linux/aria2c_build" + cd "$GITHUB_WORKSPACE" + wget https://github.com/aria2/aria2/releases/download/release-1.37.0/aria2-1.37.0.tar.gz + tar -xzf aria2-1.37.0.tar.gz + cd aria2-1.37.0 + CFLAGS="-Os -s" LDFLAGS="-static" ./configure \ + --enable-static --disable-shared \ + --disable-libaria2 --without-ca-bundle \ + --without-libnettle --without-libgcrypt \ + --without-libssh2 --without-libexpat \ + --without-libxml2 --without-libsqlite3 \ + --with-openssl + make -j"$(nproc)" + strip src/aria2c + cp src/aria2c "$GITHUB_WORKSPACE/dist/linux/bin/aria2c" + chmod +x "$GITHUB_WORKSPACE/dist/linux/bin/aria2c" + rm -rf "$GITHUB_WORKSPACE/dist/linux/aria2c_build" "$GITHUB_WORKSPACE/aria2-1.37.0" "$GITHUB_WORKSPACE/aria2-1.37.0.tar.gz" + + + - name: Show cache status and bin contents + run: | + echo "Cache hit: ${{ steps.aria2-cache.outputs.cache-hit }}" + echo "Listing dist/linux/bin:" + ls -la dist/linux/bin || true + + - name: Cleanup FFmpeg temp + run: rm -rf "$GITHUB_WORKSPACE/dist/linux/ffmpeg_temp" "$GITHUB_WORKSPACE/dist/linux/ffmpeg.tar.xz" + + - name: Archive Linux package + run: | + set -e + VERSION="${{ steps.version.outputs.version }}" + cd "$GITHUB_WORKSPACE/dist/linux" + TAR_NAME="yt-playlist-linux-${VERSION}.tar.gz" + tar -czf "$GITHUB_WORKSPACE/$TAR_NAME" * + + - name: Upload Linux artifact + uses: actions/upload-artifact@v4 + with: + name: linux-release + path: ${{ github.workspace }}/yt-playlist-linux-${{ steps.version.outputs.version }}.tar.gz + + build-docker-image: + runs-on: ubuntu-latest + needs: [build-linux-package] + steps: + - uses: actions/checkout@v5 + + - name: Get version from tag + id: version + shell: bash + run: | + if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then + VERSION="${{ inputs.tag }}" + elif [ "${{ github.event_name }}" = "release" ]; then + VERSION="${{ github.event.release.tag_name }}" + else + VERSION="${{ github.ref_name }}" + fi + VERSION="${VERSION#v}" + echo "version=$VERSION" >> $GITHUB_OUTPUT + + - name: Set docker image names + run: | + echo "RELEASE_IMAGE=ghcr.io/${GITHUB_ACTOR}/ytpld:${{ steps.version.outputs.version }}" >> $GITHUB_ENV + echo "LATEST_IMAGE=ghcr.io/${GITHUB_ACTOR}/ytpld:latest" >> $GITHUB_ENV + + - name: Download linux artifact + uses: actions/download-artifact@v4 + with: + name: linux-release + + - name: Prepare Docker build context + run: | + mkdir -p dist/linux-docker + cp Dockerfile dist/linux-docker/ + echo "Copying and extracting Linux artifact..." + tar -xzf yt-playlist-linux-${{ steps.version.outputs.version }}.tar.gz -C dist/linux-docker/ + echo "Build context contents:" + ls -R dist/linux-docker + + - name: Build Docker image (release) + run: docker build dist/linux-docker -t $RELEASE_IMAGE + + - name: Save Docker image as tar (release) + run: docker save -o docker-image.tar $RELEASE_IMAGE + + - name: Upload docker-image artifact + uses: actions/upload-artifact@v4 + with: + name: docker-image + path: docker-image.tar + + - name: Build Docker image (latest) + run: docker build dist/linux-docker --label build_as_latest=true -t $LATEST_IMAGE + + - name: Save Docker image as tar (latest) + run: docker save -o docker-image-latest.tar $LATEST_IMAGE + + - name: Upload docker-image-latest artifact + uses: actions/upload-artifact@v4 + with: + name: docker-image-latest + path: docker-image-latest.tar + + release: + runs-on: ubuntu-latest + needs: [build-windows-package, build-linux-package, build-docker-image] + steps: + - uses: actions/download-artifact@v4 + with: + name: windows-release + path: windows-release + - uses: actions/download-artifact@v4 + with: + name: linux-release + path: linux-release + - uses: actions/download-artifact@v4 + with: + name: docker-image + path: docker-image + - uses: actions/download-artifact@v4 + with: + name: docker-image-latest + path: docker-image-latest + + - name: Get version from tag + id: version + shell: bash + run: | + if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then + VERSION="${{ inputs.tag }}" + elif [ "${{ github.event_name }}" = "release" ]; then + VERSION="${{ github.event.release.tag_name }}" + else + VERSION="${{ github.ref_name }}" + fi + VERSION="${VERSION#v}" + echo "version=$VERSION" >> $GITHUB_OUTPUT + - name: Set docker image names + run: | + echo "RELEASE_IMAGE=ghcr.io/${GITHUB_ACTOR}/ytpld:${{ steps.version.outputs.version }}" >> $GITHUB_ENV + echo "LATEST_IMAGE=ghcr.io/${GITHUB_ACTOR}/ytpld:latest" >> $GITHUB_ENV + - name: Login to GitHub Container Registry + uses: docker/login-action@v3 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - name: Load and push Docker release image + run: | + docker load -i docker-image/docker-image.tar + docker push $RELEASE_IMAGE + - name: Load and push Docker latest image + run: | + docker load -i docker-image-latest/docker-image-latest.tar + docker push $LATEST_IMAGE + + - name: Create GitHub Release + id: create_release + uses: actions/create-release@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + tag_name: ${{ steps.version.outputs.version }} + release_name: "Release ${{ steps.version.outputs.version }}" + draft: true + - name: Upload Windows release asset + uses: actions/upload-release-asset@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + upload_url: ${{ steps.create_release.outputs.upload_url }} + asset_path: windows-release/yt-playlist-windows-${{ steps.version.outputs.version }}.zip + asset_name: yt-playlist-windows-${{ steps.version.outputs.version }}.zip + asset_content_type: application/zip + - name: Upload Linux release asset + uses: actions/upload-release-asset@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + upload_url: ${{ steps.create_release.outputs.upload_url }} + asset_path: linux-release/yt-playlist-linux-${{ steps.version.outputs.version }}.tar.gz + asset_name: yt-playlist-linux-${{ steps.version.outputs.version }}.tar.gz + asset_content_type: application/gzip \ No newline at end of file diff --git a/.gitea/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml similarity index 100% rename from .gitea/workflows/unit-tests.yml rename to .github/workflows/unit-tests.yml diff --git a/project plan.md b/project plan.md new file mode 100644 index 0000000..775df59 --- /dev/null +++ b/project plan.md @@ -0,0 +1,49 @@ +# Project Plan + +## Subject Area + +- TBD + +## Problem + +- TBD + +## Users Definition + +Individuals who need to download a large number of videos or audio files from a YouTube playlist and keep it updated + +## Functionality Definition + +- Can download: + - Video only + - Audio only + - Both video and audio +- Can update the playlist (download only newly added videos) +- Can delete videos that are no longer in the playlist +- Has configuration for: + - Quality + - Download type (audio, video) + - Save directory + - Use of aria2c + - aria2c-related settings + - GUI settings + +## GUI + +- Has buttons for all features +- Allows adjusting all settings from the GUI +- Modern Design + +## Platform + +- Desktop application +- Optional: + - Web App + - Android App + +## Languages + +- Backend + - Python +- Frontend + - qt ?