docs: add FAQ section #380
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Quickstarts Workflow | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main, '*.x'] | |
| types: | |
| - opened | |
| - reopened | |
| - synchronize | |
| paths-ignore: | |
| - 'LICENSE*' | |
| - '.gitignore' | |
| - '**.md' | |
| - '**.adoc' | |
| - '*.txt' | |
| jobs: | |
| java: | |
| name: "Java Quickstarts" | |
| runs-on: ubuntu-latest | |
| concurrency: | |
| group: downstream-quickstarts-${{ github.event_name }}-${{ github.head_ref }} | |
| cancel-in-progress: true | |
| timeout-minutes: 120 | |
| steps: | |
| # Clone timefold-solver | |
| # No need to check for stale repo, as Github merges the main repo into the fork automatically. | |
| - name: Checkout timefold-solver | |
| uses: actions/checkout@v4 | |
| with: | |
| path: ./timefold-solver | |
| # Clone timefold-quickstarts | |
| # Need to check for stale repo, since Github is not aware of the build chain and therefore doesn't automate it. | |
| - name: Checkout timefold-quickstarts (PR) # Checkout the PR branch first, if it exists | |
| if: github.head_ref # Only true if this is a PR. | |
| id: checkout-quickstarts-pr | |
| uses: actions/checkout@v4 | |
| continue-on-error: true | |
| with: | |
| repository: ${{ github.actor }}/timefold-quickstarts | |
| ref: ${{ github.head_ref }} | |
| path: ./timefold-quickstarts | |
| fetch-depth: 0 # Otherwise merge will fail on account of not having history. | |
| - name: Checkout timefold-quickstarts (development) # Checkout the development branch if the PR branch does not exist | |
| if: ${{ steps.checkout-quickstarts-pr.outcome != 'success' }} | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: TimefoldAI/timefold-quickstarts | |
| ref: development | |
| path: ./timefold-quickstarts | |
| fetch-depth: 0 # Otherwise merge will fail on account of not having history. | |
| # Build and test | |
| - name: Setup Temurin 21 and Maven | |
| uses: actions/setup-java@v4 | |
| with: | |
| java-version: '21' | |
| distribution: 'temurin' | |
| cache: 'maven' | |
| - name: Quickly build timefold-solver | |
| working-directory: ./timefold-solver | |
| shell: bash | |
| run: mvn -B -Dquickly clean install | |
| - name: Build and test timefold-quickstarts | |
| working-directory: ./timefold-quickstarts | |
| shell: bash | |
| run: mvn -B clean verify | |
| python: | |
| name: "Python Quickstarts" | |
| concurrency: | |
| group: pull_request_python_quickstarts-${{ github.event_name }}-${{ github.head_ref }}-${{ matrix.os }}-${{ matrix.java-version }}-${{ matrix.python-version }} | |
| cancel-in-progress: true | |
| strategy: | |
| matrix: | |
| os: [ ubuntu-latest ] | |
| java-version: [ 21 ] # Only the latest supported LTS; already too many jobs here. | |
| # TODO: Add Python 3.10 once employee scheduling and school timetabling support it | |
| python-version: ['3.11', '3.12'] | |
| fail-fast: false | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Check out repository code | |
| uses: actions/checkout@v4 | |
| with: | |
| path: './timefold-solver' | |
| # Need to check for stale repo, since Github is not aware of the build chain and therefore doesn't automate it. | |
| - name: Checkout timefold-quickstarts (PR) # Checkout the PR branch first, if it exists | |
| id: checkout-quickstarts-pr | |
| uses: actions/checkout@v4 | |
| continue-on-error: true | |
| with: | |
| repository: ${{ github.actor }}/timefold-quickstarts | |
| ref: ${{ github.head_ref }} | |
| path: ./timefold-quickstarts | |
| fetch-depth: 0 # Otherwise merge will fail on account of not having history. | |
| - name: Checkout timefold-quickstarts (development) # Checkout the development branch if the PR branch does not exist | |
| if: steps.checkout-quickstarts-pr.outcome != 'success' | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: TimefoldAI/timefold-quickstarts | |
| ref: development | |
| path: ./timefold-quickstarts | |
| fetch-depth: 0 # Otherwise merge will fail on account of not having history. | |
| # Build and test | |
| - name: "Setup Java and Maven" | |
| uses: actions/setup-java@v4 | |
| with: | |
| java-version: ${{matrix.java-version}} | |
| distribution: 'temurin' | |
| cache: 'maven' | |
| - name: Python Setup | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{matrix.python-version}} | |
| cache: 'pip' | |
| cache-dependency-path: | | |
| **/setup.py | |
| - name: Install build | |
| run: | |
| pip install build | |
| - name: Build Timefold Solver for Python | |
| working-directory: ./timefold-solver | |
| run: python -m build | |
| - name: Build and test timefold-quickstarts | |
| working-directory: ./timefold-quickstarts | |
| env: | |
| TIMEFOLD_SOLVER_PYTHON_DIST: "${{ github.workspace }}/timefold-solver/dist" | |
| run: .github/scripts/run_python_tests.sh |