Merge pull request #151 from Erotemic/dev/1.3.4 #795
Workflow file for this run
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
| # This workflow will install Python dependencies, run tests and lint with a variety of Python versions | |
| # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions | |
| # Based on ~/code/xcookie/xcookie/rc/tests.yml.in | |
| # Now based on ~/code/xcookie/xcookie/builders/github_actions.py | |
| # See: https://github.com/Erotemic/xcookie | |
| name: PurePyCI | |
| on: | |
| push: | |
| pull_request: | |
| branches: [ main ] | |
| jobs: | |
| lint_job: | |
| ## | |
| # Run quick linting and typing checks. | |
| # To disable all linting add "linter=false" to the xcookie config. | |
| # To disable type checks add "notypes" to the xcookie tags. | |
| ## | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4 | |
| - name: Set up Python 3.12 for linting | |
| uses: actions/setup-python@v4.7.1 | |
| with: | |
| python-version: '3.12' | |
| - name: Install dependencies | |
| run: |- | |
| python -m pip install --upgrade pip | |
| python -m pip install flake8 | |
| - name: Lint with flake8 | |
| run: |- | |
| # stop the build if there are Python syntax errors or undefined names | |
| flake8 ./ubelt --count --select=E9,F63,F7,F82 --show-source --statistics | |
| - name: Typecheck with mypy | |
| run: |- | |
| python -m pip install mypy | |
| mypy --install-types --non-interactive ./ubelt | |
| mypy ./ubelt | |
| build_and_test_sdist: | |
| ## | |
| # Build the pure python package from source and test it in the | |
| # same environment. | |
| ## | |
| name: Build sdist | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4 | |
| - name: Set up Python 3.12 | |
| uses: actions/setup-python@v4.7.1 | |
| with: | |
| python-version: '3.12' | |
| - name: Upgrade pip | |
| run: |- | |
| python -m pip install --upgrade pip | |
| python -m pip install --prefer-binary -r requirements/tests.txt | |
| python -m pip install --prefer-binary -r requirements/runtime.txt | |
| - name: Build sdist | |
| shell: bash | |
| run: |- | |
| python -m pip install pip -U | |
| python -m pip install setuptools>=0.8 wheel build | |
| python -m build --sdist --outdir wheelhouse | |
| - name: Install sdist | |
| run: |- | |
| ls -al ./wheelhouse | |
| pip install --prefer-binary wheelhouse/ubelt*.tar.gz -v | |
| - name: Test minimal loose sdist | |
| run: |- | |
| pwd | |
| ls -al | |
| # Run in a sandboxed directory | |
| WORKSPACE_DNAME="testsrcdir_minimal_${CI_PYTHON_VERSION}_${GITHUB_RUN_ID}_${RUNNER_OS}" | |
| mkdir -p $WORKSPACE_DNAME | |
| cd $WORKSPACE_DNAME | |
| # Run the tests | |
| # Get path to installed package | |
| MOD_DPATH=$(python -c "import ubelt, os; print(os.path.dirname(ubelt.__file__))") | |
| echo "MOD_DPATH = $MOD_DPATH" | |
| python -m pytest --verbose --cov={self.mod_name} $MOD_DPATH ../tests | |
| cd .. | |
| - name: Test full loose sdist | |
| run: |- | |
| pwd | |
| ls -al | |
| true | |
| # Run in a sandboxed directory | |
| WORKSPACE_DNAME="testsrcdir_full_${CI_PYTHON_VERSION}_${GITHUB_RUN_ID}_${RUNNER_OS}" | |
| mkdir -p $WORKSPACE_DNAME | |
| cd $WORKSPACE_DNAME | |
| # Run the tests | |
| # Get path to installed package | |
| MOD_DPATH=$(python -c "import ubelt, os; print(os.path.dirname(ubelt.__file__))") | |
| echo "MOD_DPATH = $MOD_DPATH" | |
| python -m pytest --verbose --cov={self.mod_name} $MOD_DPATH ../tests | |
| cd .. | |
| - name: Upload sdist artifact | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: wheels | |
| path: ./wheelhouse/*.tar.gz | |
| build_purepy_wheels: | |
| ## | |
| # Download and test the pure-python wheels that were build in the | |
| # build_purepy_wheels and test them in this independent environment. | |
| ## | |
| name: ${{ matrix.python-version }} on ${{ matrix.os }}, arch=${{ matrix.arch }} with ${{ matrix.install-extras }} | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: | |
| - ubuntu-latest | |
| python-version: | |
| - '3.12' | |
| arch: | |
| - auto | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4 | |
| - name: Set up QEMU | |
| uses: docker/setup-qemu-action@v3 | |
| if: runner.os == 'Linux' && matrix.arch != 'auto' | |
| with: | |
| platforms: all | |
| - name: Setup Python | |
| uses: actions/setup-python@v4.7.1 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Build pure wheel | |
| shell: bash | |
| run: |- | |
| python -m pip install setuptools>=0.8 wheel build twine | |
| python -m build --wheel --outdir wheelhouse | |
| python -m twine check ./wheelhouse/ubelt*.whl | |
| - name: Show built files | |
| shell: bash | |
| run: ls -la wheelhouse | |
| - uses: actions/upload-artifact@v3 | |
| name: Upload wheels artifact | |
| with: | |
| name: wheels | |
| path: ./wheelhouse/ubelt*.whl | |
| test_purepy_wheels: | |
| name: ${{ matrix.python-version }} on ${{ matrix.os }}, arch=${{ matrix.arch }} with ${{ matrix.install-extras }} | |
| runs-on: ${{ matrix.os }} | |
| needs: | |
| - build_purepy_wheels | |
| strategy: | |
| matrix: | |
| # Xcookie generates an explicit list of environments that will be used | |
| # for testing instead of using the more concise matrix notation. | |
| include: | |
| - python-version: '3.6' | |
| install-extras: tests-strict,runtime-strict | |
| os: ubuntu-20.04 | |
| arch: auto | |
| - python-version: '3.6' | |
| install-extras: tests-strict,runtime-strict | |
| os: macOS-latest | |
| arch: auto | |
| - python-version: '3.6' | |
| install-extras: tests-strict,runtime-strict | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.12' | |
| install-extras: tests-strict,runtime-strict,optional-strict | |
| os: ubuntu-latest | |
| arch: auto | |
| - python-version: '3.12' | |
| install-extras: tests-strict,runtime-strict,optional-strict | |
| os: macOS-latest | |
| arch: auto | |
| - python-version: '3.12' | |
| install-extras: tests-strict,runtime-strict,optional-strict | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.12' | |
| install-extras: tests | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.12' | |
| install-extras: tests | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.6' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.7' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.8' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.9' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.10' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.11' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.12' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: pypy-3.7 | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.6' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.7' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.8' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.9' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.10' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.11' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.12' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: pypy-3.7 | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.6' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.7' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.8' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.9' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.10' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.11' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: '3.12' | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: pypy-3.7 | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: pypy-3.7 | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: pypy-3.7 | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| - python-version: pypy-3.7 | |
| install-extras: tests,optional | |
| os: windows-latest | |
| arch: auto | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4 | |
| - name: Enable MSVC 64bit | |
| uses: ilammy/msvc-dev-cmd@v1 | |
| if: matrix.os == 'windows-latest' | |
| - name: Set up QEMU | |
| uses: docker/setup-qemu-action@v3 | |
| if: runner.os == 'Linux' && matrix.arch != 'auto' | |
| with: | |
| platforms: all | |
| - name: Setup Python | |
| uses: actions/setup-python@v4.7.1 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - uses: actions/download-artifact@v3 | |
| name: Download wheels | |
| with: | |
| name: wheels | |
| path: wheelhouse | |
| - name: Install wheel ${{ matrix.install-extras }} | |
| shell: bash | |
| env: | |
| INSTALL_EXTRAS: ${{ matrix.install-extras }} | |
| run: |- | |
| echo "Finding the path to the wheel" | |
| ls wheelhouse || echo "wheelhouse does not exist" | |
| echo "Installing helpers" | |
| pip install setuptools>=0.8 setuptools_scm wheel build -U | |
| pip install tomli pkginfo | |
| export WHEEL_FPATH=$(python -c "import pathlib; print(str(sorted(pathlib.Path('wheelhouse').glob('ubelt*.whl'))[-1]).replace(chr(92), chr(47)))") | |
| export MOD_VERSION=$(python -c "from pkginfo import Wheel; print(Wheel('$WHEEL_FPATH').version)") | |
| pip install --prefer-binary "ubelt[$INSTALL_EXTRAS]==$MOD_VERSION" -f wheelhouse | |
| echo "Install finished." | |
| - name: Test wheel ${{ matrix.install-extras }} | |
| shell: bash | |
| env: | |
| CI_PYTHON_VERSION: py${{ matrix.python-version }} | |
| run: |- | |
| echo "Creating test sandbox directory" | |
| export WORKSPACE_DNAME="testdir_${CI_PYTHON_VERSION}_${GITHUB_RUN_ID}_${RUNNER_OS}" | |
| echo "WORKSPACE_DNAME=$WORKSPACE_DNAME" | |
| mkdir -p $WORKSPACE_DNAME | |
| echo "cd-ing into the workspace" | |
| cd $WORKSPACE_DNAME | |
| pwd | |
| ls -altr | |
| # Get the path to the installed package and run the tests | |
| export MOD_DPATH=$(python -c "import ubelt, os; print(os.path.dirname(ubelt.__file__))") | |
| echo " | |
| --- | |
| MOD_DPATH = $MOD_DPATH | |
| --- | |
| running the pytest command inside the workspace | |
| --- | |
| " | |
| python -m pytest --verbose -p pytester -p no:doctest --xdoctest --cov-config ../pyproject.toml --cov-report term --cov="ubelt" "$MOD_DPATH" ../tests | |
| echo "pytest command finished, moving the coverage file to the repo root" | |
| ls -al | |
| # Move coverage file to a new name | |
| mv .coverage "../.coverage.$WORKSPACE_DNAME" | |
| echo "changing directory back to th repo root" | |
| cd .. | |
| ls -al | |
| - name: Combine coverage Linux | |
| if: runner.os == 'Linux' | |
| run: |- | |
| echo '############ PWD' | |
| pwd | |
| cp .wheelhouse/.coverage* . || true | |
| ls -al | |
| python -m pip install coverage[toml] | |
| echo '############ combine' | |
| coverage combine . || true | |
| echo '############ XML' | |
| coverage xml -o ./coverage.xml || true | |
| echo '### The cwd should now have a coverage.xml' | |
| ls -altr | |
| pwd | |
| - uses: codecov/codecov-action@v3 | |
| name: Codecov Upload | |
| with: | |
| file: ./coverage.xml | |
| test_deploy: | |
| name: Uploading Test to PyPi | |
| runs-on: ubuntu-latest | |
| if: github.event_name == 'push' && ! startsWith(github.event.ref, 'refs/tags') && ! startsWith(github.event.ref, 'refs/heads/release') | |
| needs: | |
| - build_and_test_sdist | |
| - build_purepy_wheels | |
| - test_purepy_wheels | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4 | |
| - uses: actions/download-artifact@v3 | |
| name: Download wheels and sdist | |
| with: | |
| name: wheels | |
| path: wheelhouse | |
| - name: Show files to upload | |
| shell: bash | |
| run: ls -la wheelhouse | |
| - name: Sign and Publish | |
| env: | |
| TWINE_REPOSITORY_URL: https://test.pypi.org/legacy/ | |
| TWINE_USERNAME: __token__ | |
| TWINE_PASSWORD: ${{ secrets.TEST_TWINE_PASSWORD }} | |
| CI_SECRET: ${{ secrets.CI_SECRET }} | |
| run: |- | |
| GPG_EXECUTABLE=gpg | |
| $GPG_EXECUTABLE --version | |
| openssl version | |
| $GPG_EXECUTABLE --list-keys | |
| echo "Decrypting Keys" | |
| openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:CI_SECRET -d -a -in dev/ci_public_gpg_key.pgp.enc | $GPG_EXECUTABLE --import | |
| openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:CI_SECRET -d -a -in dev/gpg_owner_trust.enc | $GPG_EXECUTABLE --import-ownertrust | |
| openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:CI_SECRET -d -a -in dev/ci_secret_gpg_subkeys.pgp.enc | $GPG_EXECUTABLE --import | |
| echo "Finish Decrypt Keys" | |
| $GPG_EXECUTABLE --list-keys || true | |
| $GPG_EXECUTABLE --list-keys || echo "first invocation of gpg creates directories and returns 1" | |
| $GPG_EXECUTABLE --list-keys | |
| VERSION=$(python -c "import setup; print(setup.VERSION)") | |
| pip install twine | |
| pip install urllib3 requests[security] twine | |
| GPG_KEYID=$(cat dev/public_gpg_key) | |
| echo "GPG_KEYID = '$GPG_KEYID'" | |
| DO_GPG=True GPG_KEYID=$GPG_KEYID TWINE_REPOSITORY_URL=${TWINE_REPOSITORY_URL} TWINE_PASSWORD=$TWINE_PASSWORD TWINE_USERNAME=$TWINE_USERNAME GPG_EXECUTABLE=$GPG_EXECUTABLE DO_UPLOAD=True DO_TAG=False ./publish.sh | |
| live_deploy: | |
| name: Uploading Live to PyPi | |
| runs-on: ubuntu-latest | |
| if: github.event_name == 'push' && (startsWith(github.event.ref, 'refs/tags') || startsWith(github.event.ref, 'refs/heads/release')) | |
| needs: | |
| - build_and_test_sdist | |
| - build_purepy_wheels | |
| - test_purepy_wheels | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4 | |
| - uses: actions/download-artifact@v3 | |
| name: Download wheels and sdist | |
| with: | |
| name: wheels | |
| path: wheelhouse | |
| - name: Show files to upload | |
| shell: bash | |
| run: ls -la wheelhouse | |
| - name: Sign and Publish | |
| env: | |
| TWINE_REPOSITORY_URL: https://upload.pypi.org/legacy/ | |
| TWINE_USERNAME: __token__ | |
| TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }} | |
| CI_SECRET: ${{ secrets.CI_SECRET }} | |
| run: |- | |
| GPG_EXECUTABLE=gpg | |
| $GPG_EXECUTABLE --version | |
| openssl version | |
| $GPG_EXECUTABLE --list-keys | |
| echo "Decrypting Keys" | |
| openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:CI_SECRET -d -a -in dev/ci_public_gpg_key.pgp.enc | $GPG_EXECUTABLE --import | |
| openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:CI_SECRET -d -a -in dev/gpg_owner_trust.enc | $GPG_EXECUTABLE --import-ownertrust | |
| openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:CI_SECRET -d -a -in dev/ci_secret_gpg_subkeys.pgp.enc | $GPG_EXECUTABLE --import | |
| echo "Finish Decrypt Keys" | |
| $GPG_EXECUTABLE --list-keys || true | |
| $GPG_EXECUTABLE --list-keys || echo "first invocation of gpg creates directories and returns 1" | |
| $GPG_EXECUTABLE --list-keys | |
| VERSION=$(python -c "import setup; print(setup.VERSION)") | |
| pip install twine | |
| pip install urllib3 requests[security] twine | |
| GPG_KEYID=$(cat dev/public_gpg_key) | |
| echo "GPG_KEYID = '$GPG_KEYID'" | |
| DO_GPG=True GPG_KEYID=$GPG_KEYID TWINE_REPOSITORY_URL=${TWINE_REPOSITORY_URL} TWINE_PASSWORD=$TWINE_PASSWORD TWINE_USERNAME=$TWINE_USERNAME GPG_EXECUTABLE=$GPG_EXECUTABLE DO_UPLOAD=True DO_TAG=False ./publish.sh | |
| ### | |
| # Unfortunately we cant (yet) use the yaml docstring trick here | |
| # https://github.community/t/allow-unused-keys-in-workflow-yaml-files/172120 | |
| #__doc__: | | |
| # # How to run locally | |
| # # https://packaging.python.org/guides/using-testpypi/ | |
| # git clone https://github.com/nektos/act.git $HOME/code/act | |
| # chmod +x $HOME/code/act/install.sh | |
| # (cd $HOME/code/act && ./install.sh -b $HOME/.local/opt/act) | |
| # | |
| # load_secrets | |
| # unset GITHUB_TOKEN | |
| # $HOME/.local/opt/act/act \ | |
| # --secret=EROTEMIC_TWINE_PASSWORD=$EROTEMIC_TWINE_PASSWORD \ | |
| # --secret=EROTEMIC_TWINE_USERNAME=$EROTEMIC_TWINE_USERNAME \ | |
| # --secret=EROTEMIC_CI_SECRET=$EROTEMIC_CI_SECRET \ | |
| # --secret=EROTEMIC_TEST_TWINE_USERNAME=$EROTEMIC_TEST_TWINE_USERNAME \ | |
| # --secret=EROTEMIC_TEST_TWINE_PASSWORD=$EROTEMIC_TEST_TWINE_PASSWORD |