test_release.yml

name: Python pytest
# do not change name
on: 
  push:
    branches:
    - main
    - dev
  pull_request:
    branches:
    - main
    - dev
  release: 
    types: [edited, created]

permissions: write-all

jobs:
  build-linux:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python: ['3.8','3.9','3.10','3.11']

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python 3.x
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python }}
        
    - name: Install dependencies
      run: |
        pip install poetry==1.8.3
        poetry config virtualenvs.create false
        poetry check --lock
        poetry install --extras sentence_transformers --with test
        
    
    - name: Lint with flake8
      run: |
        # stop the build if there are Python syntax errors or undefined names
        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics    
    
    - name: test create shinx docs
      # create shpinx api autodocs of hf_hub_ctranslate2 and move them to docs
      # makefile: make html build the the docs/_build/html/
      run: |
        sphinx-apidoc -o ./docs ./hf_hub_ctranslate2
        cp README.md ./docs
        cd docs
        make html

    - name: Generate Report
      run: |
        coverage run -m --source=hf_hub_ctranslate2 pytest tests 
        coverage xml
    - name: Upload coverage to Codecov for python 3.8
      if: ${{ matrix.python == '3.10' }}
      uses: codecov/codecov-action@v2

  deploy_docs:
    if: ${{ success() && github.event_name == 'release' }}
    needs: build-linux
    runs-on: ubuntu-latest
    # only run if pytest successfull
    steps:
    - name: Checkout current branch
      uses: actions/checkout@v4
      with:
        path: 'branch-dir'
        
    - name: Checkout gh-pages branch
      uses: actions/checkout@v4
      with:
        ref: 'gh-pages'
        path: 'gh-pages-dir'

    - name: Install dependencies from current branch
      run: |
        cd branch-dir
        pip install poetry==1.8.3
        poetry install --extras sentence_transformers --with test
    - name: create shinx docs from current branch
      # create shpinx api autodocs of opensentiment and move them to docs
      # makefile: make html build the the docs/_build/html/
      run: |
        cd branch-dir
        poetry run sphinx-apidoc -o ./docs ./hf_hub_ctranslate2
        cp README.md ./docs
        cd docs
        poetry run make html
    
    - name: merge /docs/_build/ files into gh-pages branch
      run: |
        # move all files to gh-pages branch
        cp -r branch-dir/docs/_build/html/* gh-pages-dir/
        cp -r branch-dir/.gitignore gh-pages-dir/
        # configure gh-pages-dir / gh-pages branch
        ls -a
        cd gh-pages-dir
        ls -a
        # create nojekyll file
        touch .nojekyll
        git config --local user.email "action@github.com"
        git config --local user.name "GitHub Action"
        # add local files and untrack
        git add .
        git commit -m "Update documentation" -a || true
        # The above command will fail if no changes were present, so we ignore
        # that.

    - name: Push changes to github repo/gh-pages
      uses: ad-m/github-push-action@master
      with:
         branch: refs/heads/gh-pages
         directory: gh-pages-dir/

  deploy_pypi:
    needs: deploy_docs
    runs-on: ubuntu-latest
    name: Build and publish Python 🐍 distributions 📦 to PyPI
    permissions:
      id-token: write
    environment:
      name: publish
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python 3.10
      uses: actions/setup-python@v5
      with:
        python-version: "3.10"
    
    - name: Install pypa/build
      run: |
        pip install build --user
    - name: Build a binary wheel and a source tarball
      run: |
        python -m build --sdist --wheel --outdir dist/

    # - name: Publish distribution 📦 to Test PyPI
    #   uses: pypa/gh-action-pypi-publish@release/v1
    #   with:
    #     repository_url: https://test.pypi.org/legacy/

    - name: Publish package distributions to PyPI
      if: startsWith(github.ref, 'refs/tags')
      uses: pypa/gh-action-pypi-publish@release/v1
      with:
        packages-dir: dist/
        verbose: true
        print-hash: true