reusable-publish.yml

# This is a reusable workflow for building source distributions (sdist) and wheels of a given target package.
# The target package must be coupled with a Makefile with the following recipes: version, setup-dev, package, publish, publish-test

name: Build and Publish

on:
  workflow_call:
    inputs:
      package-path:
        type: string
        description: Path to the package root directory.
        required: false
        default: "."
      version-increment:
        type: boolean
        description: Increment patch version number.
        required: false
        default: true
      package-wheels:
        type: boolean
        description: Package wheels.
        required: false
        default: true
      publish-test:
        type: boolean
        description: Publish to PyPI test.
        required: false
        default: true
      publish:
        type: boolean
        description: Publish to PyPI.
        required: false
        default: true
      pypi-api-token-secret:
        type: string
        description: Name of the PyPI API token secret.
        required: false
        default: "PYPI_API_TOKEN_DATASCOPE"
      pypi-test-api-token-secret:
        type: string
        description: Name of the PyPI Test API token secret.
        required: false
        default: "PYPI_TEST_API_TOKEN_DATASCOPE"
  workflow_dispatch:
    inputs:
      package-path:
        type: string
        description: Path to the package root directory.
        required: false
        default: "."
      version-increment:
        type: boolean
        description: Increment patch version number.
        required: false
        default: true
      package-wheels:
        type: boolean
        description: Package wheels.
        required: false
        default: true
      publish-test:
        type: boolean
        description: Publish to PyPI test.
        required: false
        default: true
      publish:
        type: boolean
        description: Publish to PyPI.
        required: false
        default: true
      pypi-api-token-secret:
        type: string
        description: Name of the PyPI API token secret.
        required: false
        default: "PYPI_API_TOKEN_DATASCOPE"
      pypi-test-api-token-secret:
        type: string
        description: Name of the PyPI Test API token secret.
        required: false
        default: "PYPI_TEST_API_TOKEN_DATASCOPE"

env:
  python-version: "3.9"

jobs:
  version:
    name: Increment Patch Version Number
    runs-on: ubuntu-latest
    if: inputs.version-increment == true
    outputs:
      sha: ${{ steps.sha.outputs.SHA }}
    steps:
    - uses: actions/checkout@v3
    - name: Set up Python ${{ env.python-version }}
      uses: actions/setup-python@v3
      with:
        python-version: ${{ env.python-version }}
    - name: Increment Version
      working-directory: ${{ inputs.package-path }}
      run: |
        make version
    - name: Commit Version File
      uses: stefanzweifel/git-auto-commit-action@v4
      with:
        commit_message: Increment Patch Version Number
        file_pattern: "*version.py"
    - name: Get SHA of the Latest Commit
      id: sha
      run: |
        sha_new=$(git rev-parse HEAD)
        echo $sha_new
        echo "SHA=$sha_new" >> $GITHUB_OUTPUT
  
  package_sdist:
    name: Package Python Source Distribution
    needs: version
    if: ${{ always() && !contains(join(needs.*.result, ','), 'failure') }}
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
      with:
        ref: ${{ needs.version.outputs.sha }}
    - name: Set up Python ${{ env.python-version }}
      uses: actions/setup-python@v3
      with:
        python-version: ${{ env.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        make setup-dev
    - name: Package sdist
      working-directory: ${{ inputs.package-path }}
      run: |
        make package
    - name: Upload Artifacts
      uses: actions/upload-artifact@v3
      with:
        path: ${{ inputs.package-path }}/dist/*.tar.gz
  
  package_wheels:
    name: Package wheels on ${{ matrix.os }}
    needs: version
    if: ${{ always() && inputs.package-wheels == true && !contains(join(needs.*.result, ','), 'failure') }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-20.04, windows-2019, macos-10.15]

    steps:
    - uses: actions/checkout@v3
      with:
        ref: ${{ needs.version.outputs.sha }}
    - uses: actions/setup-python@v3
      name: Install Python
      with:
        python-version: ${{ env.python-version }}

    - name: Build wheels
      uses: pypa/cibuildwheel@v2.11.4
      env:
        CIBW_SKIP: cp36-* pp*
      with:
        package-dir: ${{ inputs.package-path }}
        output-dir: ${{ inputs.package-path }}/dist

    - uses: actions/upload-artifact@v3
      with:
        path: ${{ inputs.package-path }}/dist/*.whl
  
  publish:
    name: Publish to PyPi
    needs: [package_sdist, package_wheels]
    runs-on: ubuntu-latest
    if: (inputs.publish-test == true || inputs.publish == true) && always() && contains(join(needs.*.result, ','), 'success')
    steps:
    - uses: actions/checkout@v3
    - name: Set up Python ${{ env.python-version }}
      uses: actions/setup-python@v3
      with:
        python-version: ${{ env.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install twine
    - uses: actions/download-artifact@v3
      with:
        name: artifact
        path: ${{ inputs.package-path }}/dist
    - name: Publish to PyPI Test
      if: inputs.publish-test == true
      working-directory: ${{ inputs.package-path }}
      env:
        TWINE_PASSWORD: ${{ secrets[inputs.pypi-test-api-token-secret] }}
      run: |
        make publish-test
    - name: Publish to PyPI
      if: inputs.publish == true
      working-directory: ${{ inputs.package-path }}
      env:
        TWINE_PASSWORD: ${{ secrets[inputs.pypi-api-token-secret] }}
      run: |
        make publish