push-pull.yml

# This runs jobs which pyiron modules should run on pushes or PRs to main
# Usage:
#   on:
#     push:
#       branches: [ main ]
#     pull_request:
#       branches: [ main ]

name: Push or Pull

on:
  workflow_call:
    inputs:
      do-commit-updated-env:
        type: boolean
        description: 'Feature flag: controls if the commit-updated-env step does anything or gets skipped over.'
        default: true
        required: false
      do-build-docs:
        type: boolean
        description: 'Feature flag: controls if the build-docs job runs.'
        default: true
        required: false
      do-build-notebooks:
        type: boolean
        description: 'Feature flag: controls if the build-notebooks job runs.'
        default: true
        required: false
      do-unit-tests:
        type: boolean
        description: 'Feature flag: controls if the unit-tests job runs.'
        default: true
        required: false
      do-coveralls:
        type: boolean
        description: 'Whether to use the coveralls/github-action after generating coverage. If neither do-coveralls nor do-codacy are true, the coveralls-and-codacy job is skipped.'
        default: true
        required: false
      do-codacy:
        type: boolean
        description: 'Whether to push the report to codacy after generating coverage. If neither do-coveralls nor do-codacy are true, the coveralls-and-codacy job is skipped.'
        default: true
        required: false
      do-benchmark-tests:
        type: boolean
        description: 'Feature flag: controls if the benchmark-tests job runs.'
        default: true
        required: false
      do-pip-check:
        type: boolean
        description: 'Feature flag: controls if the pip-check job runs.'
        default: true
        required: false
      do-black:
        type: boolean
        description: 'Feature flag: controls if the black job runs.'
        default: true
        required: false
      docs-env-files:
        type: string
        description: 'Paths to an arbitrary number of (space-separated) conda environment yaml files'
        default: .ci_support/environment.yml
        required: false
      notebooks-env-files:
        type: string
        description: 'Paths to an arbitrary number of (space-separated) conda environment yaml files'
        default: .ci_support/environment.yml
        required: false
      notebooks-exclusion-file:
        type: string
        description: 'An optional path to a file containing the names of notebooks to NOT build'
        default: .ci_support/exclude
        required: false
      tests-env-files:
        type: string
        description: 'Paths to an arbitrary number of (space-separated) conda environment yaml files'
        default: .ci_support/environment.yml
        required: false
      unit-test-timeout-minutes:
        type: number
        description: 'timout-minutes to apply to running the unit tests'
        default: 10
        required: false
      coveralls-and-codacy-timeout-minutes:
        type: number
        description: 'timout-minutes to apply to running the coveralls and codacy tests'
        default: 15
        required: false
      benchmark-timeout-minutes:
        type: number
        description: 'How many minutes to allow tests in units/benchmark to run for'
        default: 30
        required: false
      alternate-tests-timeout-minutes:
        type: number
        description: 'How many minutes to allow tests in alternate environment tests to run for'
        default: 15
        required: false
      extra-python-paths:
        type: string
        description: 'Extra paths (e.g. test dirs tests/(benchmark,integration,unit)) to the PYTHONPATH. This is a required workaround for repos that use `pympipool` executors, [cf. this issue](https://github.com/pyiron/pympipool/issues/239).'
        default: ''
        required: false
      runner:
        type: string
        description: 'The main runner to use everywhere'
        default: 'ubuntu-latest'
        required: false
      runner-alt1:
        type: string
        description: 'An alternate runner for the unit tests (only on the main python version). Set to the string exclude to skip'
        default: 'windows-latest'
        required: false
      runner-alt2:
        type: string
        description: 'Another alternate runner for the unit tests (only on the main python version). Set to the string exclude to skip'
        default: 'macos-latest'
        required: false
      python-version:
        type: string
        description: 'The main version of python to test on, used across all three OS for tests and in other steps'
        default: '3.12'
        required: false
      python-version-alt1:
        type: string
        description: 'An alternate  version of python to run unit tests on, used only on the main runner. Set to the string exclude to skip'
        default: '3.11'
        required: false
      python-version-alt2:
        type: string
        description: 'An alternate  version of python to run unit tests on, used only on the main runner. Set to the string exclude to skip'
        default: '3.10'
        required: false
      python-version-alt3:
        type: string
        description: 'An alternate  version of python to run unit tests on, used only on the main runner. Set to the string exclude to skip'
        default: '3.9'
        required: false
      unit-test-dir:
        type: string
        description: 'The directory containing the unit tests run on the full platform and python matrix'
        default: tests/unit
        required: false
      coveralls-and-codacy-test-dir:
        type: string
        description: 'The directory containing the tests analyzed by coveralls'
        default: tests
        required: false
      benchmark-test-dir:
        type: string
        description: 'The directory containing the benchmark tests'
        default: tests/benchmark
        required: false
      omit-patterns:
        type: string
        description: 'Patterns passed to --omit for skipping coverage in all unit test calls'
        default: '*/_version.py'
        required: false
      alternate-tests-env-files:
        type: string
        description: 'An alternate set of (space-separated) conda environment yaml files, e.g. to test a lower-bounds environment. Skipped if empty'
        required: false
      alternate-tests-python-version:
        type: string
        description: 'Version of python to use with the alternate tests'
        default: '3.12'
        required: false
      alternate-tests-dir:
        type: string
        description: 'The directory containing the tests run with the alternate environment'
        default: tests
        required: false


jobs:
  commit-updated-env:  # Keep envs read by external sources (binder and readthedocs) up-to-date
    runs-on: ${{ inputs.runner }}
    steps:
      - uses: actions/checkout@v4
        with:
          token: ${{ secrets.DEPENDABOT_WORKFLOW_TOKEN }}
          ref: ${{ github.event.pull_request.head.ref }} # Check out the head of the actual branch, not the PR
          fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
        if: ${{ inputs.do-commit-updated-env }}
      - uses: pyiron/actions/write-docs-env@main
        with:
          env-files: ${{ inputs.docs-env-files }}
        if: ${{ inputs.do-commit-updated-env }}
      - uses: pyiron/actions/write-environment@main
        with:
          env-files: ${{ inputs.notebooks-env-files }}
          output-env-file: .binder/environment.yml
        if: ${{ inputs.do-commit-updated-env }}
      - name: commit
        id: commit-docs-env
        continue-on-error: true  # Allow "failure" when there are no changes (the working tree is clean)
        run: |
          git config --local user.email "pyiron@mpie.de"
          git config --local user.name "pyiron-runner"
          git add docs/environment.yml .binder/environment.yml
          git commit -m "[dependabot skip] Update env file" -a
        if: ${{ inputs.do-commit-updated-env }}
      - name: push
        if: steps.commit-docs-env.outcome == 'success'  # But only push if we made it here without continue-on-error
        uses: ad-m/github-push-action@master
        with:
          github_token: ${{ secrets.DEPENDABOT_WORKFLOW_TOKEN }}
          branch: ${{ github.event.pull_request.head.ref }}

  build-docs:
    needs: commit-updated-env
    if: ${{ inputs.do-build-docs }}
    runs-on: ${{ inputs.runner }}
    steps:
      - uses: actions/checkout@v4
      - uses: pyiron/actions/build-docs@main
        with:
          python-version: ${{ inputs.python-version }}
          env-files: ${{ inputs.docs-env-files }}

  build-notebooks:
    needs: commit-updated-env
    if: ${{ inputs.do-build-notebooks }}
    runs-on: ${{ inputs.runner }}
    steps:
      - uses: actions/checkout@v4
      - uses: pyiron/actions/build-notebooks@main
        with:
          python-version: ${{ inputs.python-version }}
          env-files: ${{ inputs.notebooks-env-files }}
          exclusion-file: ${{ inputs.notebooks-exclusion-file }}


  unit-tests:
    needs: commit-updated-env
    if: ${{ inputs.do-unit-tests }}
    runs-on: ${{ matrix.operating-system }}
    # All three runners for the highest python version
    # Only the main for up to two more versions of python
    strategy:
      matrix:
        operating-system: ["${{ inputs.runner }}", "${{ inputs.runner-alt1 }}", "${{ inputs.runner-alt2 }}"]
        python-version: ["${{ inputs.python-version }}", "${{ inputs.python-version-alt1 }}", "${{ inputs.python-version-alt2 }}", "${{ inputs.python-version-alt3 }}"]
        exclude:
          # Get rid of all combinations of alternative runners and alternative python versions
          - operating-system: ${{ inputs.runner-alt1 }}
            python-version: ${{ inputs.python-version-alt1 }}
          - operating-system: ${{ inputs.runner-alt1 }}
            python-version: ${{ inputs.python-version-alt2 }}
          - operating-system: ${{ inputs.runner-alt1 }}
            python-version: ${{ inputs.python-version-alt3 }}
          - operating-system: ${{ inputs.runner-alt2 }}
            python-version: ${{ inputs.python-version-alt1 }}
          - operating-system: ${{ inputs.runner-alt2 }}
            python-version: ${{ inputs.python-version-alt2 }}
          - operating-system: ${{ inputs.runner-alt2 }}
            python-version: ${{ inputs.python-version-alt3 }}
          # Don't run anything tagged with "exclude"
          - operating-system: 'exclude'
          - python-version: 'exclude'

    steps:
    - uses: actions/checkout@v4
    - uses: pyiron/actions/add-to-python-path@main
      if: inputs.extra-python-paths != ''
      with:
        path-dirs: ${{ inputs.extra-python-paths }}
    - uses: pyiron/actions/unit-tests@main
      with:
        python-version: ${{ matrix.python-version }}
        env-files: ${{ inputs.tests-env-files }}
        test-dir: ${{ inputs.unit-test-dir }}
        omit-patterns: ${{ inputs.omit-patterns }}
      timeout-minutes: ${{ inputs.unit-test-timeout-minutes }}

  coveralls-and-codacy:
    needs: commit-updated-env
    if: ${{ inputs.do-coveralls || inputs.do-codacy }}
    uses: pyiron/actions/.github/workflows/tests-and-coverage.yml@main
    secrets: inherit
    with:
      tests-env-files: ${{ inputs.tests-env-files }}
      extra-python-paths: ${{ inputs.extra-python-paths }}
      runner: ${{ inputs.runner }}
      python-version: ${{ inputs.python-version }}
      test-dir: ${{ inputs.coveralls-and-codacy-test-dir }}
      omit-patterns: ${{ inputs.omit-patterns }}
      do-coveralls: ${{ inputs.do-coveralls }}
      do-codacy: ${{ inputs.do-codacy }}
      test-timeout-minutes: ${{ inputs.coveralls-and-codacy-timeout-minutes }}

  benchmark-tests:
    needs: commit-updated-env
    if: ${{ inputs.do-benchmark-tests }}
    runs-on: ${{ inputs.runner }}
    steps:
    - uses: actions/checkout@v4
    - uses: pyiron/actions/unit-tests@main
      with:
        python-version: ${{ inputs.python-version }}
        env-files: ${{ inputs.tests-env-files }}
        test-dir: ${{ inputs.benchmark-test-dir }}
        omit-patterns: ${{ inputs.omit-patterns }}
      timeout-minutes: ${{ inputs.benchmark-timeout-minutes }}

  test-alternate-env:
    if: ${{ inputs.alternate-tests-env-files != '' }}
    runs-on: ${{ inputs.runner }}
    steps:
    - uses: actions/checkout@v4
    - uses: pyiron/actions/add-to-python-path@main
      if: inputs.extra-python-paths != ''
      with:
        path-dirs: ${{ inputs.extra-python-paths }}
    - uses: pyiron/actions/unit-tests@main
      with:
        python-version: ${{ inputs.alternate-tests-python-version }}
        env-files: ${{ inputs.alternate-tests-env-files }}
        test-dir: ${{ inputs.alternate-tests-dir }}
        omit-patterns: ${{ inputs.omit-patterns }}
      timeout-minutes:  ${{ inputs.alternate-tests-timeout-minutes }}

  pip-check:
    needs: commit-updated-env
    if: ${{ inputs.do-pip-check }}
    runs-on: ${{ inputs.runner }}
    steps:
      - uses: actions/checkout@v4
      - uses: pyiron/actions/pip-check@main
        with:
          python-version: ${{ inputs.python-version }}

  black:
    needs: commit-updated-env
    if: ${{ inputs.do-black }}
    runs-on: ${{ inputs.runner }}
    steps:
      - uses: actions/checkout@v4
      - uses: psf/black@stable
        with:
          options: "--check --diff"
          src: ./${{ github.event.repository.name }}