build-source.yml

name: Build QuantLibAddin source archives

# Manually-triggered build of the downloadable QuantLibAddin SOURCE archives
# (a .zip for Windows users and a .tar.gz for Linux users).
#
# The key feature is that gensrc is run BEFORE the archive is created, so the
# autogenerated sources are already present.  That lets an end user compile the
# "Basic" build straight from the archive without having to install Python and
# run gensrc themselves.
#
# gensrc is pure Python: it needs Python 3 only - no C++ compiler, no Boost and
# no QuantLib clone.  Two commands are run, mirroring gensrc/CMakeLists.txt:
#   ObjectHandler : python gensrc/gensrc.py -xdlv --oh_dir=..          (cwd ObjectHandler/gensrc)
#   QuantLibAddin : python gensrc/gensrc.py -a    --oh_dir=../../ObjectHandler (cwd QuantLibAddin/gensrc)
# Both platforms use the full "-a" generation (Option A): the archives contain
# identical files and differ only in line endings (CRLF in the zip, LF in the
# tarball).
#
# QuantLib itself is NOT bundled - users obtain the matching QuantLib release
# separately.

on:
  workflow_dispatch:
    inputs:
      make_release:
        description: "Publish the source archives as GitHub Release assets"
        required: true
        type: boolean
        default: false
      release_tag:
        description: "Tag of the GitHub Release to attach the archives to (e.g. v1.42.0). Required when publishing."
        required: false
        default: "v1.42.0"

permissions:
  contents: write

env:
  # Release/package version. Matches the version used by the XLL/docs workflows.
  QLXL_VERSION: "1.42.0"

jobs:
  # ---------------------------------------------------------------------------
  # Windows source zip (CRLF line endings).
  # ---------------------------------------------------------------------------
  source-zip:
    runs-on: windows-latest
    steps:
      - name: Checkout QuantLibAddin
        uses: actions/checkout@v4

      - name: Set up Python 3
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"

      - name: Run gensrc (generate sources)
        shell: bash
        run: |
          set -e
          echo "::group::ObjectHandler gensrc"
          ( cd ObjectHandler/gensrc && python "$GITHUB_WORKSPACE/gensrc/gensrc.py" -xdlv --oh_dir=.. )
          echo "::endgroup::"
          echo "::group::QuantLibAddin gensrc"
          ( cd QuantLibAddin/gensrc && python "$GITHUB_WORKSPACE/gensrc/gensrc.py" -a --oh_dir=../../ObjectHandler )
          echo "::endgroup::"

      - name: Stage source tree
        shell: bash
        run: |
          set -e
          root="dist/QuantLibAddin-${QLXL_VERSION}"
          mkdir -p "$root"
          # Copy the working tree into the staging root, excluding VCS metadata,
          # the separate QuantLib clone and any build/IDE artifacts.  rsync is
          # not available on windows-latest (Git Bash), so use tar, which is.
          tar \
            --exclude='./.git' \
            --exclude='./dist' \
            --exclude='./QuantLib' \
            --exclude='./build' \
            --exclude='./build*' \
            --exclude='./out' \
            --exclude='./.vs' \
            --exclude='__pycache__' \
            --exclude='*.pyc' \
            -cf - . | tar -xf - -C "$root"
          echo "Staged top-level entries:"
          ls -a "$root"

      - name: Normalize line endings to CRLF
        shell: bash
        run: |
          set -e
          root="dist/QuantLibAddin-${QLXL_VERSION}"
          # Convert LF -> CRLF on text sources so Windows users get native
          # line endings.  Binary files are left untouched.
          find "$root" -type f \
            \( -name '*.cpp' -o -name '*.hpp' -o -name '*.h' -o -name '*.c' \
               -o -name '*.py' -o -name '*.txt' -o -name '*.docs' -o -name '*.md' \
               -o -name '*.xml' -o -name '*.vcxproj' -o -name '*.sln' -o -name '*.filters' \
               -o -name '*.props' -o -name '*.cmake' -o -name '*.yml' -o -name '*.yaml' \
               -o -name '*.i' -o -name '*.idl' -o -name '*.bas' -o -name '*.cls' \) \
            -print0 | while IFS= read -r -d '' f; do
              sed -i 's/\r*$/\r/' "$f"
            done

      - name: Create source zip
        shell: pwsh
        run: |
          $ErrorActionPreference = "Stop"
          $zip = "QuantLibAddin-$env:QLXL_VERSION.zip"
          Compress-Archive -Path "dist/QuantLibAddin-$env:QLXL_VERSION" -DestinationPath $zip -Force
          "ZIP_NAME=$zip" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
          Write-Host "Created $zip"

      - name: Upload source zip
        uses: actions/upload-artifact@v4
        with:
          name: QuantLibAddin-${{ env.QLXL_VERSION }}-zip
          path: QuantLibAddin-${{ env.QLXL_VERSION }}.zip
          if-no-files-found: error

      - name: Attach source zip to GitHub Release
        if: ${{ inputs.make_release }}
        uses: softprops/action-gh-release@v2
        with:
          tag_name: ${{ inputs.release_tag }}
          files: ${{ env.ZIP_NAME }}

  # ---------------------------------------------------------------------------
  # Linux source tarball (LF line endings).
  # ---------------------------------------------------------------------------
  source-tar:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout QuantLibAddin
        uses: actions/checkout@v4

      - name: Set up Python 3
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"

      - name: Run gensrc (generate sources)
        shell: bash
        run: |
          set -e
          echo "::group::ObjectHandler gensrc"
          ( cd ObjectHandler/gensrc && python "$GITHUB_WORKSPACE/gensrc/gensrc.py" -xdlv --oh_dir=.. )
          echo "::endgroup::"
          echo "::group::QuantLibAddin gensrc"
          ( cd QuantLibAddin/gensrc && python "$GITHUB_WORKSPACE/gensrc/gensrc.py" -a --oh_dir=../../ObjectHandler )
          echo "::endgroup::"

      - name: Stage source tree
        shell: bash
        run: |
          set -e
          root="dist/QuantLibAddin-${QLXL_VERSION}"
          mkdir -p "$root"
          rsync -a \
            --exclude '.git' \
            --exclude 'dist' \
            --exclude 'QuantLib' \
            --exclude 'build' \
            --exclude 'build*' \
            --exclude 'out' \
            --exclude '.vs' \
            --exclude '__pycache__' \
            --exclude '*.pyc' \
            ./ "$root/"
          echo "Staged top-level entries:"
          ls -a "$root"

      - name: Normalize line endings to LF
        shell: bash
        run: |
          set -e
          root="dist/QuantLibAddin-${QLXL_VERSION}"
          # Strip any CR so Linux users get LF-only text sources.
          find "$root" -type f \
            \( -name '*.cpp' -o -name '*.hpp' -o -name '*.h' -o -name '*.c' \
               -o -name '*.py' -o -name '*.txt' -o -name '*.docs' -o -name '*.md' \
               -o -name '*.xml' -o -name '*.vcxproj' -o -name '*.sln' -o -name '*.filters' \
               -o -name '*.props' -o -name '*.cmake' -o -name '*.yml' -o -name '*.yaml' \
               -o -name '*.i' -o -name '*.idl' -o -name '*.bas' -o -name '*.cls' \) \
            -print0 | while IFS= read -r -d '' f; do
              sed -i 's/\r$//' "$f"
            done

      - name: Create source tarball
        shell: bash
        run: |
          set -e
          tar_name="QuantLibAddin-${QLXL_VERSION}.tar.gz"
          ( cd dist && tar czf "../${tar_name}" "QuantLibAddin-${QLXL_VERSION}" )
          echo "TAR_NAME=${tar_name}" >> "$GITHUB_ENV"
          echo "Created ${tar_name}"

      - name: Upload source tarball
        uses: actions/upload-artifact@v4
        with:
          name: QuantLibAddin-${{ env.QLXL_VERSION }}-tar
          path: QuantLibAddin-${{ env.QLXL_VERSION }}.tar.gz
          if-no-files-found: error

      - name: Attach source tarball to GitHub Release
        if: ${{ inputs.make_release }}
        uses: softprops/action-gh-release@v2
        with:
          tag_name: ${{ inputs.release_tag }}
          files: ${{ env.TAR_NAME }}