Skip to content

Commit

Permalink
Add github actions test/build workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
readicculus committed May 3, 2024
1 parent ad589ab commit 6dd4a91
Show file tree
Hide file tree
Showing 4 changed files with 220 additions and 4 deletions.
56 changes: 56 additions & 0 deletions .github/actions/setup-venv/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Python virtualenv
description: Set up a Python virtual environment with caching
inputs:
python-version:
description: The Python version to use
required: true
cache-prefix:
description: Update this to invalidate the cache
required: true
default: v0
runs:
using: composite
steps:
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: ${{ inputs.python-version }}

- shell: bash
run: |
# Install prerequisites.
pip install --upgrade pip setuptools wheel virtualenv
- shell: bash
run: |
# Get the exact Python version to use in the cache key.
echo "PYTHON_VERSION=$(python --version)" >> $GITHUB_ENV
- uses: actions/cache@v2
id: virtualenv-cache
with:
path: .venv
key: ${{ inputs.cache-prefix }}-${{ runner.os }}-${{ env.PYTHON_VERSION }}-${{ hashFiles('pyproject.toml') }}

- if: steps.virtualenv-cache.outputs.cache-hit != 'true'
shell: bash
run: |
# Set up virtual environment without cache hit.
test -d .venv || virtualenv -p $(which python) --copies --reset-app-data .venv
. .venv/bin/activate
pip install -e .[dev]
- if: steps.virtualenv-cache.outputs.cache-hit == 'true'
shell: bash
run: |
# Set up virtual environment from cache hit.
. .venv/bin/activate
pip install --no-deps -e .[dev]
- shell: bash
run: |
# Show environment info.
. .venv/bin/activate
echo "✓ Installed $(python --version) virtual environment to $(which python)"
echo "Packages:"
pip freeze
149 changes: 149 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
name: Main

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

on:
pull_request:
branches:
- main
push:
branches:
- main
tags:
- "v*.*.*"

env:
# Change this to invalidate existing cache.
CACHE_PREFIX: v0
PYTHONPATH: ./

jobs:
checks:
name: Python ${{ matrix.python }} - ${{ matrix.task.name }}
runs-on: [ubuntu-latest]
timeout-minutes: 15
strategy:
fail-fast: false
matrix:
python: ["3.8", "3.10"]
task:
- name: Test
run: |
pytest -v --color=yes tests/
include:
- python: "3.10"
task:
name: Lint
run: ruff check .
#
# - python: "3.10"
# task:
# name: Type check
# run: mypy .

- python: "3.10"
task:
name: Build
run: |
python -m build
- python: "3.10"
task:
name: Style
run: |
isort --check .
black --check .
# - python: "3.10"
# task:
# name: Docs
# run: cd docs && make html

steps:
- uses: actions/checkout@v3

- name: Setup Python environment
uses: ./.github/actions/setup-venv
with:
python-version: ${{ matrix.python }}
cache-prefix: ${{ env.CACHE_PREFIX }}

# - name: Restore mypy cache
# if: matrix.task.name == 'Type check'
# uses: actions/cache@v3
# with:
# path: .mypy_cache
# key: mypy-${{ env.CACHE_PREFIX }}-${{ runner.os }}-${{ matrix.python }}-${{ hashFiles('*requirements.txt') }}-${{ github.ref }}-${{ github.sha }}
# restore-keys: |
# mypy-${{ env.CACHE_PREFIX }}-${{ runner.os }}-${{ matrix.python }}-${{ hashFiles('*requirements.txt') }}-${{ github.ref }}
# mypy-${{ env.CACHE_PREFIX }}-${{ runner.os }}-${{ matrix.python }}-${{ hashFiles('*requirements.txt') }}

- name: ${{ matrix.task.name }}
run: |
. .venv/bin/activate
${{ matrix.task.run }}
- name: Upload package distribution files
if: matrix.task.name == 'Build'
uses: actions/upload-artifact@v3
with:
name: package
path: dist

- name: Clean up
if: always()
run: |
. .venv/bin/activate
pip uninstall -y my-package
# release:
# name: Release
# runs-on: ubuntu-latest
# needs: [checks]
# if: startsWith(github.ref, 'refs/tags/')
# steps:
# - uses: actions/checkout@v3
# with:
# fetch-depth: 0
#
# - name: Setup Python
# uses: actions/setup-python@v4
# with:
# python-version: "3.10"
#
# - name: Install requirements
# run: |
# pip install --upgrade pip setuptools wheel build
# pip install -e .[dev]
#
# - name: Prepare environment
# run: |
# echo "RELEASE_VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV
# echo "TAG=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
#
# - name: Download package distribution files
# uses: actions/download-artifact@v3
# with:
# name: package
# path: dist
#
# - name: Generate release notes
# run: |
# python scripts/release_notes.py > ${{ github.workspace }}-RELEASE_NOTES.md
#
# - name: Publish package to PyPI
# run: |
# twine upload -u '${{ secrets.PYPI_USERNAME }}' -p '${{ secrets.PYPI_PASSWORD }}' dist/*

# - name: Publish GitHub release
# uses: softprops/action-gh-release@v1
# env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# with:
# body_path: ${{ github.workspace }}-RELEASE_NOTES.md
# prerelease: ${{ contains(env.TAG, 'rc') }}
# files: |
# dist/*
18 changes: 15 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,26 @@
# rm -rf docs/build/
# sphinx-autobuild -b html --watch src/pysh / docs/source/ docs/build/

.PHONY : run-checks
run-checks :
.PHONY : test
test :
isort --check .
black --check .
ruff check .
CUDA_VISIBLE_DEVICES='' pytest -v --color=yes --doctest-modules tests/ src/pysh/

.PHONY : clean
clean :
rm -rf src/pysh/*.egg-info/
rm -rf build/
rm -rf dist/

.PHONY : build
build :
rm -rf *.egg-info/
rm -rf src/pysh/*.egg-info/
python -m build

.PHONY : release
release :
$(MAKE) clean
$(MAKE) test
python -m build
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ include-package-data = true
[tool.setuptools.package-data]
my_package = ["py.typed"]


[tool.black]
line-length = 100
include = '\.pyi?$'
Expand Down

0 comments on commit 6dd4a91

Please sign in to comment.