Getting Started for Developers¶

name: Continuous Integration

on:
    pull_request:
        types: [opened, ready_for_review, reopened, synchronize]
    workflow_call:
    workflow_dispatch:

concurrency:
    group: ${{ github.job }}/${{ github.workflow }}/${{ github.head_ref || github.ref }}
    cancel-in-progress: true

jobs:
    ci-default-python-version:
        name: Default Python Version
        runs-on: ubuntu-latest
        permissions:
            contents: write
            pull-requests: write
        timeout-minutes: 120

        steps:
            - name: Check out repository
              uses: actions/checkout@v6

            - name: Set up uv
              uses: astral-sh/setup-uv@v7

            - name: Lint & test
              uses: ./.github/actions/lint-test

            - name: Add coverage comment
              if: github.event_name == 'pull_request'
              uses: MishaKav/pytest-coverage-comment@v1
              with:
                  coverage-path-prefix: "binned_cdf/"
                  junitxml-path: pytest.xml
                  pytest-xml-coverage-path: coverage.xml

            - name: Build & deploy temporary docs
              if: github.event_name == 'pull_request' && github.event.pull_request.draft == false
              uses: ./.github/actions/publish-docs
              with:
                  alias: pr-${{ github.event.number }}
                  version: next-pr-${{ github.event.number }}

            - name: Add docs comment
              if: github.event_name == 'pull_request' && github.event.pull_request.draft == false
              uses: marocchino/sticky-pull-request-comment@v2.9.4
              with:
                  header: docs-comment
                  message: |
                      :books: Created [temporary docs](https://famura.github.io/binned-cdf/pr-${{ github.event.number }}).

                      Useful URLs:

                      - [Coverage](https://famura.github.io/binned-cdf/pr-${{ github.event.number }}/exported/coverage)
                      - [Tests](https://famura.github.io/binned-cdf/pr-${{ github.event.number }}/exported/tests)

    ci-other-python-versions:
        if: github.event.pull_request.draft == false
        name: Other Python Versions
        runs-on: ubuntu-latest
        strategy:
            matrix:
                python-version: [3.13]
        timeout-minutes: 120

        steps:
            - name: Check out repository
              uses: actions/checkout@v6

            - name: Set up uv
              uses: astral-sh/setup-uv@v7

            - name: Set Python version to ${{ matrix.python-version }}
              run: uv python pin ${{ matrix.python-version }}

            - name: Lint & test
              uses: ./.github/actions/lint-test

name: Continuous Deployment

on:
    push:
        branches: [main]
    workflow_dispatch:
        inputs:
            bumped-version-part:
                description: "The version part to bump."
                type: choice
                options:
                    - major
                    - minor
                    - patch
                default: patch
                required: true

concurrency:
    group: ${{ github.workflow }}/${{ github.head_ref || github.ref }}
    cancel-in-progress: true

jobs:
    bump-version:
        name: Bump Version
        runs-on: ubuntu-latest
        container: docker:git
        permissions:
            contents: write
        timeout-minutes: 10
        steps:
            - name: Install prerequisites
              run: apk add nodejs

            - name: Check out repository
              uses: actions/checkout@v6

            - name: Bump version and push tag
              id: version
              uses: mathieudutour/github-tag-action@v6.2
              with:
                  default_bump: ${{ github.event.inputs.bumped-version-part || 'patch' }}
                  github_token: ${{ secrets.GITHUB_TOKEN }}

            - name: Add version info
              run: echo "Bumped ${VERSION_PART} version part from ${OLD_TAG} to ${NEW_TAG}." >> $GITHUB_STEP_SUMMARY
              env:
                  VERSION_PART: ${{ steps.version.outputs.release_type }}
                  OLD_TAG: ${{ steps.version.outputs.previous_tag }}
                  NEW_TAG: ${{ steps.version.outputs.new_tag }}

    ci:
        name: CI
        needs: bump-version
        uses: ./.github/workflows/ci.yaml
        secrets: inherit
        permissions:
            contents: write
            pull-requests: write

    deploy:
        name: Deploy Docs
        needs: ci
        if: github.repository == 'famura/binned-cdf'
        runs-on: ubuntu-latest
        timeout-minutes: 30
        permissions:
            contents: write
        steps:
            - name: Check out repository
              uses: actions/checkout@v6
              with:
                  fetch-depth: 0

            - name: Set up uv
              uses: astral-sh/setup-uv@v7

            - name: Lint & test
              uses: ./.github/actions/lint-test

            - name: Build & publish docs
              uses: ./.github/actions/publish-docs

    publish-pypi:
        name: Publish to PyPI
        needs: deploy
        runs-on: ubuntu-latest
        environment: release
        timeout-minutes: 15
        permissions:
            id-token: write
        steps:
            - name: Check out repository
              uses: actions/checkout@v6
              with:
                  fetch-depth: 0 # it is necessary for versioningit to get full git history

            - name: Set up uv
              uses: astral-sh/setup-uv@v7

            - name: Build package
              run: uv build

            - name: Publish to PyPI
              uses: pypa/gh-action-pypi-publish@release/v1