CI/CD Documentation

Documentation for NLSQ’s continuous integration and deployment pipeline.

• GitHub Actions - Developer Guide
  • Overview
  • Workflow Schema Validation
  • Common Patterns
  • NLSQ Workflow Structure
  • Local Testing
  • Best Practices
  • Resources

Overview

NLSQ uses GitHub Actions for automated testing, code quality checks, and deployments:

• Test Suite: Automated testing on Python 3.12/3.13/3.14 (3819 tests, 100% pass rate)

• Code Quality: Pre-commit hooks, ruff, mypy

• Coverage: Automated coverage reporting (target: 80%)

Workflow Files

NLSQ’s GitHub Actions workflows:

• .github/workflows/main.yml - Main test suite and code quality checks

• .github/workflows/release.yml - Package publishing and release automation

GitHub Actions Guide

GitHub Actions - Developer Guide

Guide to GitHub Actions workflow syntax and validation.

Local Testing

Run CI checks locally before pushing:

# Run pre-commit hooks
pre-commit run --all-files

# Run full test suite
make test

# Run with coverage
make test-cov

# Check code quality
make lint

See PyPI Publishing Setup Guide for release pipeline documentation.