langflow/.github/workflows/release.yml

name: Langflow Release
run-name: Langflow Release by @${{ github.actor }}

on:
  workflow_dispatch:
    inputs:
      release_tag:
        description: "Tag to release from. This is the tag that contains the source code for the release."
        required: true
        type: string
      release_package_base:
        description: "Release Langflow Base"
        required: true
        type: boolean
        default: false
      release_package_main:
        description: "Release Langflow"
        required: true
        type: boolean
        default: false
      release_lfx:
        description: "WARNING: Not implemented yet."
        required: true
        type: boolean
        default: false
      build_docker_base:
        description: "Build Docker Image for Langflow Base"
        required: true
        type: boolean
        default: false
      build_docker_main:
        description: "Build Docker Image for Langflow"
        required: true
        type: boolean
        default: false
      pre_release:
        description: "Pre-release"
        required: false
        type: boolean
        default: false
      create_release:
        description: "Whether to create a gh release"
        required: false
        type: boolean
        default: false
      dry_run:
        description: "Dry run mode - disables all pushes to external services (PyPI, Docker, GitHub releases)"
        required: false
        type: boolean
        default: true

jobs:
  echo-inputs:
    name: Echo Workflow Inputs
    runs-on: ubuntu-latest
    steps:
      - name: Echo workflow inputs
        run: |
          echo "release_tag: ${{ inputs.release_tag }}"
          echo "release_package_base: ${{ inputs.release_package_base }}"
          echo "release_package_main: ${{ inputs.release_package_main }}"
          echo "release_lfx: ${{ inputs.release_lfx }}"
          echo "build_docker_base: ${{ inputs.build_docker_base }}"
          echo "build_docker_main: ${{ inputs.build_docker_main }}"
          echo "pre_release: ${{ inputs.pre_release }}"
          echo "create_release: ${{ inputs.create_release }}"
          echo "dry_run: ${{ inputs.dry_run }}"

  validate-tag:
    name: Validate Tag Input
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v5
        with:
          fetch-depth: 0 # Fetch all history - required for tags (?)
      - name: Validate that input is a tag, not a branch
        run: |
          # Check if the input exists as a tag
          if ! git tag -l | grep -q "^${{ inputs.release_tag }}$"; then
            echo "Error: '${{ inputs.release_tag }}' is not a valid tag."
            echo "Available tags:"
            git tag -l | head -20
            exit 1
          fi

          # Check if the input also exists as a branch (warn if so, but don't fail)
          if git branch -r | grep -q "origin/${{ inputs.release_tag }}$"; then
            echo "Tag '${{ inputs.release_tag }}' also exists as a branch. Exiting out of caution."
            exit 1
          fi

          echo "Validated: '${{ inputs.release_tag }}' is a valid tag."

  validate-dependencies:
    name: Validate Release Dependencies
    runs-on: ubuntu-latest
    if: ${{ inputs.release_package_base || inputs.release_package_main || inputs.release_lfx || inputs.build_docker_base || inputs.build_docker_main }}
    needs: [validate-tag]
    steps:
      - name: Validate that build-base is enabled if build-main is enabled
        run: |
          if [ "${{ inputs.release_package_main }}" = "true" ] && [ "${{ inputs.release_package_base }}" = "false" ]; then
            echo "Error: Cannot release Langflow Main without releasing Langflow Base."
            echo "Please enable 'release_package_base' or disable 'release_package_main'."
            exit 1
          fi

          if [ "${{ inputs.release_lfx }}" = "true" ]; then
            echo "Error: Release LFX is not implemented yet."
            echo "Please disable 'release_lfx' or wait for it to be implemented."
            exit 1
          fi

          echo "✅ Release dependencies validated successfully."

  ci:
    name: CI
    needs: [validate-tag, validate-dependencies]
    uses: ./.github/workflows/ci.yml
    with:
      ref: ${{ inputs.release_tag }}
      python-versions: "['3.10', '3.11', '3.12', '3.13']"
      frontend-tests-folder: "tests"
      release: true
      run-all-tests: true
      runs-on: ubuntu-latest
    secrets: inherit

  build-base:
    name: Build Langflow Base
    needs: [ci]
    if: ${{ inputs.release_package_base }}
    runs-on: ubuntu-latest
    outputs:
      version: ${{ steps.check-version.outputs.version }}
      skipped: ${{ steps.check-version.outputs.skipped }}
    steps:
      - name: Checkout code
        uses: actions/checkout@v5
        with:
          ref: ${{ inputs.release_tag }}
      - name: Setup Environment
        uses: astral-sh/setup-uv@v6
        with:
          enable-cache: true
          cache-dependency-glob: "uv.lock"
          python-version: "3.13"
          prune-cache: false
      - name: Install the project
        run: uv sync
      - name: Check for dependency incompatibility
        run: uv pip check
      - name: Check Version
        id: check-version
        run: |
          version=$(uv tree | grep 'langflow-base' | awk '{print $3}' | sed 's/^v//' | head -n 2 | xargs)
          last_released_version=$(curl -s "https://pypi.org/pypi/langflow-base/json" | jq -r '.releases | keys | .[]' | sort -V | tail -n 1)
          if [ "$version" = "$last_released_version" ]; then
            echo "Version $version is already released. Skipping release."
            echo skipped=true >> $GITHUB_OUTPUT
            exit 1
          else
            echo version=$version >> $GITHUB_OUTPUT
            echo skipped=false >> $GITHUB_OUTPUT
          fi
      - name: Build project for distribution
        if: steps.check-version.outputs.skipped == 'false'
        run: make build base=true args="--wheel"
      - name: Test CLI
        if: steps.check-version.outputs.skipped == 'false'
        run: |
          # TODO: Unsure why the whl is not built in src/backend/base/dist
          mkdir src/backend/base/dist
          mv dist/*.whl src/backend/base/dist
          uv pip install src/backend/base/dist/*.whl
          uv run python -m langflow run --host localhost --port 7860 --backend-only &
          SERVER_PID=$!
          # Wait for the server to start
          timeout 120 bash -c 'until curl -f http://localhost:7860/api/v1/auto_login; do sleep 2; done' || (echo "Server did not start in time" && kill $SERVER_PID && exit 1)
          # Terminate the server
          kill $SERVER_PID || (echo "Failed to terminate the server" && exit 1)
          sleep 20 # give the server some time to terminate
          # Check if the server is still running
          if kill -0 $SERVER_PID 2>/dev/null; then
            echo "Failed to terminate the server"
            exit 0
          else
            echo "Server terminated successfully"
          fi

      # PyPI publishing moved to after cross-platform testing

      - name: Upload Artifact
        if: steps.check-version.outputs.skipped == 'false'
        uses: actions/upload-artifact@v4
        with:
          name: dist-base
          path: src/backend/base/dist

  build-main:
    name: Build Langflow Main
    if: ${{ inputs.release_package_main }}
    needs: [build-base]
    runs-on: ubuntu-latest
    outputs:
      version: ${{ steps.check-version.outputs.version }}
    steps:
      - name: Checkout code
        uses: actions/checkout@v5
        with:
          ref: ${{ inputs.release_tag }}
      - name: Setup Environment
        uses: astral-sh/setup-uv@v6
        with:
          enable-cache: true
          cache-dependency-glob: "uv.lock"
          python-version: "3.13"
          prune-cache: false
      - name: Install the project
        run: uv sync
      - name: Check for dependency incompatibility
        run: uv pip check

      # If pre-release is true, we need to check if  ["a", "b", "rc", "dev", "post"] is in the version string
      # if the version string is incorrect, we need to exit the workflow
      - name: Check if pre-release
        if: inputs.pre_release
        run: |
          version=$(uv tree | grep 'langflow' | grep -v 'langflow-base' | awk '{print $2}' | sed 's/^v//')
          if [[ "${version}" =~ ^([0-9]+\.)?([0-9]+\.)?[0-9]+((a|b|rc|dev|post)([0-9]+))$ ]]; then
            echo "Pre-release version detected. Continuing with the release."
          else
            echo "Invalid pre-release version detected. Exiting the workflow."
            exit 1
          fi
      - name: Check Version
        id: check-version
        run: |
          version=$(uv tree | grep 'langflow' | grep -v 'langflow-base' | awk '{print $2}' | sed 's/^v//')
          last_released_version=$(curl -s "https://pypi.org/pypi/langflow/json" | jq -r '.releases | keys | .[]' | sort -V | tail -n 1)
          if [ "$version" = "$last_released_version" ]; then
            echo "Version $version is already released. Skipping release."
            echo skipped=true >> $GITHUB_OUTPUT
            exit 1
          else
            echo version=$version >> $GITHUB_OUTPUT
          fi
      - name: Wait for PyPI Propagation
        if: needs.build-base.outputs.skipped == 'false'
        run: sleep 300 # wait for 5 minutes to ensure PyPI propagation

      - name: Build project for distribution
        run: make build main=true args="--no-sources --wheel"
      - name: Test CLI
        run: |
          uv pip install dist/*.whl
          uv run python -m langflow run --host localhost --port 7860 --backend-only &
          SERVER_PID=$!
          # Wait for the server to start
          timeout 120 bash -c 'until curl -f http://localhost:7860/health_check; do sleep 2; done' || (echo "Server did not start in time" && kill $SERVER_PID && exit 1)
          # Terminate the server
          kill $SERVER_PID || (echo "Failed to terminate the server" && exit 1)
          sleep 20 # give the server some time to terminate
          # Check if the server is still running
          if kill -0 $SERVER_PID 2>/dev/null; then
            echo "Failed to terminate the server"
            exit 0
          else
            echo "Server terminated successfully"
          fi

      # PyPI publishing moved to after cross-platform testing

      - name: Upload Artifact
        uses: actions/upload-artifact@v4
        with:
          name: dist-main
          path: dist

  test-cross-platform:
    name: Test Cross-Platform Installation
    needs: [build-base, build-main]
    if: |
      always() &&
      !cancelled() &&
      (needs.build-base.result == 'success' || needs.build-main.result == 'success')
    uses: ./.github/workflows/cross-platform-test.yml
    with:
      base-artifact-name: "dist-base"
      main-artifact-name: "dist-main"
      lfx-artifact-name: "${{ inputs.release_lfx && 'dist-lfx' || '' }}"

  publish-base:
    name: Publish Langflow Base to PyPI
    if: ${{ inputs.release_package_base }}
    needs: [build-base, test-cross-platform]
    runs-on: ubuntu-latest
    steps:
      - name: Download base artifact
        uses: actions/download-artifact@v5
        with:
          name: dist-base
          path: src/backend/base/dist
      - name: Setup Environment
        uses: astral-sh/setup-uv@v6
        with:
          enable-cache: false
          python-version: "3.13"
      - name: Publish base to PyPI
        if: ${{ !inputs.dry_run }}
        env:
          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
        run: |
          cd src/backend/base && uv publish dist/*.whl

  publish-main:
    name: Publish Langflow Main to PyPI
    if: ${{ inputs.release_package_main }}
    needs: [build-main, test-cross-platform, publish-base]
    runs-on: ubuntu-latest
    steps:
      - name: Download main artifact
        uses: actions/download-artifact@v5
        with:
          name: dist-main
          path: dist
      - name: Setup Environment
        uses: astral-sh/setup-uv@v6
        with:
          enable-cache: false
          python-version: "3.13"
      - name: Publish main to PyPI
        if: ${{ !inputs.dry_run }}
        env:
          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
        run: |
          uv publish dist/*.whl

  build-lfx:
    name: Build LFX
    needs: [ci]
    if: ${{ inputs.release_lfx }}
    runs-on: ubuntu-latest
    outputs:
      version: ${{ steps.check-version.outputs.version }}
    steps:
      - name: Checkout code
        uses: actions/checkout@v5
        with:
          ref: ${{ inputs.release_tag }}
      - name: Setup Environment
        uses: astral-sh/setup-uv@v6
        with:
          enable-cache: true
          cache-dependency-glob: "uv.lock"
          python-version: "3.13"
          prune-cache: false
      - name: Install LFX dependencies
        run: uv sync --dev --package lfx
      - name: Check Version
        id: check-version
        run: |
          cd src/lfx
          version=$(uv tree | grep 'lfx' | head -n 1 | awk '{print $2}' | sed 's/^v//')
          last_released_version=$(curl -s "https://pypi.org/pypi/lfx/json" | jq -r '.releases | keys | .[]' | sort -V | tail -n 1)
          if [ "$version" = "$last_released_version" ]; then
            echo "Version $version is already released. Skipping release."
            exit 1
          else
            echo version=$version >> $GITHUB_OUTPUT
          fi
      - name: Build project for distribution
        run: |
          cd src/lfx
          rm -rf dist/
          uv build --wheel --out-dir dist
      - name: Test CLI
        run: |
          cd src/lfx
          uv pip install dist/*.whl --force-reinstall
          uv run lfx --help
      - name: Upload Artifact
        uses: actions/upload-artifact@v4
        with:
          name: dist-lfx
          path: src/lfx/dist

  test-lfx-cross-platform:
    name: Test LFX Cross-Platform Installation
    if: ${{ inputs.release_lfx }}
    needs: [build-lfx]
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
        python-version: ["3.10", "3.11", "3.12", "3.13"]
    steps:
      - name: Download LFX artifact
        uses: actions/download-artifact@v5
        with:
          name: dist-lfx
          path: dist-lfx
      - name: Setup Environment
        uses: astral-sh/setup-uv@v6
        with:
          enable-cache: false
          python-version: ${{ matrix.python-version }}
      - name: Test LFX installation
        run: |
          uv pip install dist-lfx/*.whl
          uv run lfx --help

  publish-lfx:
    name: Publish LFX to PyPI
    if: ${{ inputs.release_lfx }}
    needs: [build-lfx, test-lfx-cross-platform]
    runs-on: ubuntu-latest
    steps:
      - name: Download LFX artifact
        uses: actions/download-artifact@v5
        with:
          name: dist-lfx
          path: src/lfx/dist
      - name: Setup Environment
        uses: astral-sh/setup-uv@v6
        with:
          enable-cache: false
          python-version: "3.13"
      - name: Publish LFX to PyPI
        if: ${{ !inputs.dry_run }}
        env:
          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
        run: |
          cd src/lfx && uv publish dist/*.whl

  call_docker_build_base:
    name: Call Docker Build Workflow for Langflow Base
    if: ${{ inputs.build_docker_base }}
    needs: [ci]
    uses: ./.github/workflows/docker-build-v2.yml
    with:
      ref: ${{ inputs.release_tag }}
      release_type: base
      pre_release: ${{ inputs.pre_release }}
      push_to_registry: ${{ !inputs.dry_run }}
    secrets: inherit

  call_docker_build_main:
    name: Call Docker Build Workflow for Langflow
    if: ${{ inputs.build_docker_main }}
    needs: [ci]
    uses: ./.github/workflows/docker-build-v2.yml
    with:
      ref: ${{ inputs.release_tag }}
      release_type: main
      pre_release: ${{ inputs.pre_release }}
      push_to_registry: ${{ !inputs.dry_run }}
    secrets: inherit

  call_docker_build_main_backend:
    name: Call Docker Build Workflow for Langflow Backend
    if: ${{ inputs.build_docker_main && !inputs.dry_run }}
    needs: [call_docker_build_main]
    uses: ./.github/workflows/docker-build-v2.yml
    with:
      ref: ${{ inputs.release_tag }}
      release_type: main-backend
      pre_release: ${{ inputs.pre_release }}
      push_to_registry: ${{ !inputs.dry_run }}
    secrets: inherit

  call_docker_build_main_frontend:
    name: Call Docker Build Workflow for Langflow Frontend
    if: ${{ inputs.build_docker_main && !inputs.dry_run }}
    needs: [call_docker_build_main]
    uses: ./.github/workflows/docker-build-v2.yml
    with:
      ref: ${{ inputs.release_tag }}
      release_type: main-frontend
      pre_release: ${{ inputs.pre_release }}
      push_to_registry: ${{ !inputs.dry_run }}
    secrets: inherit

  call_docker_build_main_ep:
    name: Call Docker Build Workflow for Langflow with Entrypoint
    if: ${{ inputs.build_docker_main }}
    needs: [ci]
    uses: ./.github/workflows/docker-build-v2.yml
    with:
      ref: ${{ inputs.release_tag }}
      release_type: main-ep
      pre_release: ${{ inputs.pre_release }}
      push_to_registry: ${{ !inputs.dry_run }}
    secrets: inherit

  call_docker_build_main_all:
    name: Call Docker Build Workflow for langflow-all
    if: ${{ inputs.build_docker_main }}
    needs: [ci]
    uses: ./.github/workflows/docker-build-v2.yml
    with:
      ref: ${{ inputs.release_tag }}
      release_type: main-all
      pre_release: ${{ inputs.pre_release }}
      push_to_registry: ${{ !inputs.dry_run }}
    secrets: inherit

  create_release:
    name: Create Release
    runs-on: ubuntu-latest
    needs: [build-main, publish-main]
    if: |
      always() &&
      !cancelled() &&
      !inputs.dry_run &&
      inputs.create_release &&
      needs.build-main.result == 'success' &&
      needs.publish-main.result == 'success'
    steps:
      - uses: actions/download-artifact@v4
        with:
          name: dist-main
          path: dist
      - name: Create Release
        uses: ncipollo/release-action@v1
        with:
          artifacts: dist/*
          token: ${{ secrets.GITHUB_TOKEN }}
          draft: false
          generateReleaseNotes: true
          prerelease: ${{ inputs.pre_release }}
          tag: ${{ needs.build-main.outputs.version }}
          allowUpdates: true
          updateOnlyUnreleased: false