ci.yml

name: CI

on:
  pull_request:
    types: [opened, synchronize, reopened, ready_for_review]
    branches-ignore:
      - '*no-ci*'
  push:
    branches:
      - master
  workflow_dispatch:
    inputs:
      ansys_version:
        description: "ANSYS version"
        required: false
        type: string
        default: "251"
      standalone_branch_suffix:
        description: 'Suffix of the branch on standalone'
        required: false
        default: ''


concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }}
  cancel-in-progress: true

env:
  DOCUMENTATION_CNAME: 'dpf.docs.pyansys.com'
  MAIN_PYTHON_VERSION: '3.9'
  MEILISEARCH_API_KEY: ${{ secrets.MEILISEARCH_API_KEY }}
  MEILISEARCH_PUBLIC_API_KEY: ${{ secrets.MEILISEARCH_PUBLIC_API_KEY }}

jobs:
  debug:
    runs-on: ubuntu-latest
    steps:
    - name: Show the Github context for the triggered event
      run: echo "$GITHUB_CONTEXT"
      env:
        GITHUB_CONTEXT: ${{ toJson(github) }}

  pick_server_suffix:
    runs-on: ubuntu-latest
    outputs:
      suffix: ${{ steps.step1.outputs.suffix }}
    steps:
    - id: step1
      name: Define server branch suffix to use
      run: |
        if ${{ github.event_name == 'push' }}; then
          echo "suffix=" >> "$GITHUB_OUTPUT"
        elif ${{ github.event_name == 'workflow_dispatch' }}; then
          echo "suffix=${{ github.event.inputs.standalone_branch_suffix }}" >> "$GITHUB_OUTPUT"
        elif ${{ github.event_name == 'pull_request' }}; then
          # If the PR is server-sync then extract suffix from branch name
          sub='maint/update_code_for_'
          if [[ "${{ github.head_ref  }}" == *"$sub"* ]]; then
            ref_name=${{ github.head_ref }}
            base_ref=${{ github.base_ref }}
            suffix=${ref_name/$sub[0-9][0-9][0-9]/''}
            suffix=${suffix/_on_$base_ref/''}
          elif [[ "${{ github.base_ref  }}" == *"$sub"* ]]; then
            base_ref=${{ github.base_ref }}
            suffix=${base_ref/$sub[0-9][0-9][0-9]/''}
            suffix=${suffix/_on_*/''}
          fi
          echo "suffix=$suffix" >> "$GITHUB_OUTPUT"
        fi
        echo "branch suffix is: >$suffix<"

  style:
    name: "Style Check"
    runs-on: ubuntu-latest
    steps:
      - uses: ansys/actions/code-style@v6
        with:
          use-python-cache: false

  build_linux1:
    name: "Build linux1 wheel"
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: "Install requirements"
        run: pip install -r requirements/requirements_build.txt

      - name: "Build the manylinux1 wheel"
        shell: bash
        id: wheel
        run: |
          python .ci/build_wheel.py -p manylinux1
          cd dist
          export name=`ls ansys_dpf_core*.whl`
          echo ${name}
          echo "wheel_name=${name[0]}" >> $GITHUB_OUTPUT
          cd ..

      - name: "Upload wheel any as artifact"
        uses: actions/upload-artifact@v3
        with:
          name: ${{ steps.wheel.outputs.wheel_name }}
          path: dist/${{ steps.wheel.outputs.wheel_name }}

  tests:
    uses: ./.github/workflows/tests.yml
    needs: pick_server_suffix
    with:
      ANSYS_VERSION: ${{ github.event.inputs.ansys_version || '251' }}
      python_versions: '["3.9"]'
      wheel: true
      wheelhouse: false
      standalone_suffix: ${{needs.pick_server_suffix.outputs.suffix}}
    secrets: inherit

  tests_any:
    uses: ./.github/workflows/tests.yml
    needs: pick_server_suffix
    with:
      ANSYS_VERSION: ${{ github.event.inputs.ansys_version || '251' }}
      python_versions: '["3.9"]'
      wheel: true
      wheelhouse: false
      standalone_suffix: ${{needs.pick_server_suffix.outputs.suffix}}
      test_any: true
    secrets: inherit

  docker_tests:
    name: "Build and Test on Docker"
    uses: ./.github/workflows/test_docker.yml
    needs: pick_server_suffix
    with:
      ANSYS_VERSION: ${{ github.event.inputs.ansys_version || '251' }}
      standalone_suffix: ${{needs.pick_server_suffix.outputs.suffix}}
    secrets: inherit

  docker_examples:
    name: "Run examples on Docker"
    uses: ./.github/workflows/examples_docker.yml
    needs: pick_server_suffix
    with:
      ANSYS_VERSION: ${{ github.event.inputs.ansys_version || '251' }}
      python_versions: '["3.9"]'
      standalone_suffix: ${{needs.pick_server_suffix.outputs.suffix}}
    secrets: inherit

  docs:
    if: startsWith(github.head_ref, 'master') || github.event.action == 'ready_for_review' || !github.event.pull_request.draft
    uses: ./.github/workflows/docs.yml
    needs: pick_server_suffix
    with:
      ANSYS_VERSION: ${{ github.event.inputs.ansys_version || '251' }}
      standalone_suffix: ${{needs.pick_server_suffix.outputs.suffix}}
      event_name: ${{ github.event_name }}
    secrets: inherit

  upload-development-docs:
    runs-on: ubuntu-latest
    if: ${{ github.ref == 'refs/heads/master' && github.event_name == 'push' }}
    needs: [docs]
    steps:
      - name: "Upload development documentation"
        uses: ansys/actions/doc-deploy-dev@v4
        with:
          cname: ${{ env.DOCUMENTATION_CNAME }}
          token: ${{ secrets.GITHUB_TOKEN }}
          doc-artifact-name: HTML-doc-ansys-dpf-core.zip
          decompress-artifact: true

  doc-index-dev:
    name: "Deploy dev index docs"
    runs-on: ubuntu-latest
    needs: upload-development-docs
    steps:
      - name: "Deploy the latest documentation index"
        uses: ansys/actions/doc-deploy-index@v4
        with:
          cname: ${{ env.DOCUMENTATION_CNAME }}/version/dev
          index-name: pydpf-core-vdev
          host-url: ${{ vars.MEILISEARCH_HOST_URL }}
          api-key: ${{ env.MEILISEARCH_API_KEY }}
          doc-artifact-name: HTML-doc-ansys-dpf-core.zip
          decompress-artifact: true

  examples:
    if: startsWith(github.head_ref, 'master') || github.event.action == 'ready_for_review' || !github.event.pull_request.draft
    uses: ./.github/workflows/examples.yml
    needs: pick_server_suffix
    with:
      ANSYS_VERSION: ${{ github.event.inputs.ansys_version || '251' }}
      python_versions: '["3.9"]'
      standalone_suffix: ${{needs.pick_server_suffix.outputs.suffix}}
    secrets: inherit

  retro_242:
    name: "retro 242"
    if: startsWith(github.head_ref, 'master') || github.event.action == 'ready_for_review' || !github.event.pull_request.draft
    uses: ./.github/workflows/tests.yml
    with:
      ANSYS_VERSION: "242"
      python_versions: '["3.9"]'
      DOCSTRING: false
      standalone_suffix: ''
    secrets: inherit

  retro_241:
    name: "retro 241"
    if: startsWith(github.head_ref, 'master') || github.event.action == 'ready_for_review' || !github.event.pull_request.draft
    uses: ./.github/workflows/tests.yml
    with:
      ANSYS_VERSION: "241"
      python_versions: '["3.9"]'
      DOCSTRING: false
      standalone_suffix: '.sp01'
    secrets: inherit

  retro_232:
    name: "retro 232"
    if: startsWith(github.head_ref, 'master') || github.event.action == 'ready_for_review' || !github.event.pull_request.draft
    uses: ./.github/workflows/tests.yml
    with:
      ANSYS_VERSION: "232"
      python_versions: '["3.9"]'
      DOCSTRING: false
      standalone_suffix: ''
    secrets: inherit

  retro_231:
    name: "retro 231"
    if: startsWith(github.head_ref, 'master') || github.event.action == 'ready_for_review' || !github.event.pull_request.draft
    uses: ./.github/workflows/tests.yml
    with:
      ANSYS_VERSION: "231"
      python_versions: '["3.9"]'
      DOCSTRING: false
    secrets: inherit

  retro_222:
    name: "retro 222"
    if: startsWith(github.head_ref, 'master') || github.event.action == 'ready_for_review' || !github.event.pull_request.draft
    uses: ./.github/workflows/tests.yml
    with:
      ANSYS_VERSION: "222"
      python_versions: '["3.9"]'
      DOCSTRING: false
    secrets: inherit

  pydpf-post:
    name: "PyDPF-Post"
    if: startsWith(github.head_ref, 'master') || github.event.action == 'ready_for_review' || !github.event.pull_request.draft
    uses: ./.github/workflows/pydpf-post.yml
    needs: pick_server_suffix
    with:
      ANSYS_VERSION: ${{ github.event.inputs.ansys_version || '251' }}
      post_branch: "master"
      standalone_suffix: ${{needs.pick_server_suffix.outputs.suffix}}
      test_docstrings: "true"
    secrets: inherit