Skip to content

Commit

Permalink
Update github workflows
Browse files Browse the repository at this point in the history
  • Loading branch information
ibro45 committed Nov 30, 2024
1 parent f2b8595 commit 84d13fe
Show file tree
Hide file tree
Showing 5 changed files with 118 additions and 190 deletions.
43 changes: 0 additions & 43 deletions .github/workflows/auto-publish.yml

This file was deleted.

53 changes: 0 additions & 53 deletions .github/workflows/build.yml

This file was deleted.

81 changes: 81 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
name: CI

on:
push:
branches: [main]
pull_request:
branches: [main]

permissions:
contents: write

jobs:
test-and-publish:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.9", "3.10", "3.11"]

steps:
- uses: actions/checkout@v3

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}

- name: Install poetry
run: make setup

- name: Set up cache
uses: actions/cache@v3
with:
path: .venv
key: venv-${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}

- name: Install dependencies
run: |
poetry config virtualenvs.in-project true
poetry install
- name: Run safety checks
run: |
poetry install --with safety
make check-safety
- name: Run style checks
continue-on-error: true
run: |
poetry install --with style
make check-codestyle
- name: Run tests
run: |
poetry install --with tests
make test
- name: Run coverage
run: |
poetry install --with tests
make coverage
# Only run publishing steps on main branch and Python 3.11
- name: Version and Publish
if: github.ref == 'refs/heads/main' && matrix.python-version == '3.11'
run: |
poetry self add poeblix@latest
poetry version prerelease
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
git add .
git commit -m "Bump version" || echo "No changes to commit"
git push
poetry blixbuild --only-lock
- name: Publish to PyPI
if: github.ref == 'refs/heads/main' && matrix.python-version == '3.9'
uses: pypa/gh-action-pypi-publish@release/v1
with:
password: ${{ secrets.PYPI_TOKEN }}
130 changes: 37 additions & 93 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,127 +1,71 @@
#* Variables
### Variables
# Define shell and Python environment variables
SHELL := /usr/bin/env bash
PYTHON := python
PYTHONPATH := `pwd`
#* Docker variables
IMAGE := lighter
VERSION := latest


#* Poetry

#* Fix for issue with poetry
### Poetry Setup
# Install Poetry and configure environment
.PHONY: setup
setup: poetry-download
@echo export PYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring >> ~/.bashrc
@echo export PYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring >> ~/.profile
source ~/.bashrc
source ~/.profile
poetry self add poetry-bumpversion@latest
poetry self add poetry-plugin-export@latest


.PHONY: poetry-download
poetry-download:
setup:
curl -sSL https://install.python-poetry.org | $(PYTHON) -
@echo "export PYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring" >> ~/.bashrc
@echo "export PYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring" >> ~/.profile
poetry self add poetry-bumpversion@latest poetry-plugin-export@latest

.PHONY: poetry-remove
poetry-remove:
curl -sSL https://install.python-poetry.org | $(PYTHON) - --uninstall

#* Installation
### Installation
# Install project dependencies
.PHONY: install
install:
poetry install -n

# Install pre-commit hooks
.PHONY: pre-commit-install
pre-commit-install:
poetry run pre-commit install

#* Formatters
.PHONY: codestyle
codestyle:
poetry run pyupgrade --exit-zero-even-if-changed --py37-plus **/*.py
poetry run isort --settings-path pyproject.toml ./
poetry run black --config pyproject.toml ./

.PHONY: formatting
formatting: codestyle

#* Linting
.PHONY: test
test:
PYTHONPATH=$(PYTHONPATH) poetry run pytest -c pyproject.toml --cov-report=html --cov=lighter tests/
poetry run coverage-badge -o assets/images/coverage.svg -f

### Linting & Testing
# Check code formatting and style
.PHONY: check-codestyle
check-codestyle:
poetry run isort --diff --check-only --settings-path pyproject.toml ./
poetry run black --diff --check --config pyproject.toml ./
poetry run pylint lighter

.PHONY: mypy
mypy:
poetry run mypy --config-file pyproject.toml ./

# Run security checks
.PHONY: check-safety
check-safety:
poetry check
poetry export | poetry run safety check --stdin
poetry run bandit -ll --recursive lighter tests

.PHONY: lint
lint: test check-codestyle mypy check-safety
# Run tests with coverage report
.PHONY: test
test:
PYTHONPATH=$(PYTHONPATH) poetry run pytest -c pyproject.toml --cov-report=html --cov=lighter tests/

# Generate coverage badge
.PHONY: coverage
coverage:
poetry run coverage-badge -o assets/images/coverage.svg -f

### Dependency Management
# Update development dependencies
.PHONY: update-dev-deps
update-dev-deps:
poetry add -G dev bandit@latest "isort[colors]@latest" mypy@latest pre-commit@latest pydocstyle@latest pylint@latest pytest@latest pyupgrade@latest safety@latest coverage@latest coverage-badge@latest pytest-html@latest pytest-cov@latest
poetry add -G dev bandit@latest "isort[colors]@latest" mypy@latest pre-commit@latest pydocstyle@latest \
pylint@latest pytest@latest pyupgrade@latest safety@latest coverage@latest coverage-badge@latest \
pytest-html@latest pytest-cov@latest
poetry add -G dev --allow-prereleases black@latest

#* Docker
# Example: make docker-build VERSION=latest
# Example: make docker-build IMAGE=some_name VERSION=0.0.1
.PHONY: docker-build
docker-build:
@echo Building docker $(IMAGE):$(VERSION) ...
docker build \
-t $(IMAGE):$(VERSION) . \
-f ./docker/Dockerfile --no-cache

# Example: make docker-remove VERSION=latest
# Example: make docker-remove IMAGE=some_name VERSION=0.0.1
.PHONY: docker-remove
docker-remove:
@echo Removing docker $(IMAGE):$(VERSION) ...
docker rmi -f $(IMAGE):$(VERSION)

#* Cleaning
.PHONY: pycache-remove
pycache-remove:
find . | grep -E "(__pycache__|\.pyc|\.pyo$$)" | xargs rm -rf
# Update main project dependencies
.PHONY: update-deps
update-deps:
poetry add torch@latest torchvision@latest pytorch_lightning@latest torchmetrics@latest monai@latest

.PHONY: dsstore-remove
dsstore-remove:
find . | grep -E ".DS_Store" | xargs rm -rf

.PHONY: mypycache-remove
mypycache-remove:
find . | grep -E ".mypy_cache" | xargs rm -rf

.PHONY: ipynbcheckpoints-remove
ipynbcheckpoints-remove:
find . | grep -E ".ipynb_checkpoints" | xargs rm -rf

.PHONY: pytestcache-remove
pytestcache-remove:
find . | grep -E ".pytest_cache" | xargs rm -rf

.PHONY: build-remove
build-remove:
### Cleaning
# Remove temporary files and build artifacts
.PHONY: clean
clean:
find . | grep -E "(__pycache__|\.pyc|\.pyo$|.DS_Store|.mypy_cache|.pytest_cache|.ipynb_checkpoints)" | xargs rm -rf
rm -rf build/

.PHONY: cleanup
cleanup: pycache-remove dsstore-remove mypycache-remove ipynbcheckpoints-remove pytestcache-remove

.PHONY: get-latest-deps
get-latest-deps:
poetry add torch@latest torchvision@latest pytorch_lightning@latest torchmetrics@latest monai@latest
1 change: 0 additions & 1 deletion diagram.svg

This file was deleted.

0 comments on commit 84d13fe

Please sign in to comment.