Skip to content

v1.1.0 - Major Update with Modern Dependencies and Documentation

Latest

Choose a tag to compare

@christoph2806 christoph2806 released this 29 Jul 08:01
· 68 commits to master since this release

πŸš€ Major Update: v1.1.0

✨ New Features

  • Comprehensive Documentation: New folder with detailed installation and usage guides
  • GitHub Pages: Jekyll-based documentation site with "Just the docs" theme
  • Multi-Architecture Docker: Support for both AMD64 and ARM64 platforms
  • Security Scanning: Automated vulnerability scanning with Trivy

πŸ“¦ Dependency Updates

  • Python: 3.8 β†’ 3.12 (latest LTS)
  • FastAPI: 0.68.0 β†’ 0.115.6 (latest stable)
  • Pydantic: 1.8.2 β†’ 2.10.3 (v2 with breaking changes)
  • Gotenberg: 7 β†’ 8 (improved PDF generation)
  • All dependencies updated to latest stable versions

πŸ› οΈ Infrastructure Improvements

  • GitHub Actions: Automated Docker build and publish to GHCR
  • GitHub Actions: Automated documentation deployment
  • Updated README: Modern, concise design with clear navigation
  • Docker Compose: Updated with latest images and removed obsolete syntax

πŸ“š Documentation

  • Installation Guide: Complete setup instructions for all environments
  • Usage Guide: Comprehensive API documentation with templating examples
  • API Reference: Interactive documentation improvements
  • GitHub Pages: Professional documentation site

πŸ”’ Security & Quality

  • Container Security: Automated vulnerability scanning
  • Multi-platform: ARM64 support for modern deployment environments
  • Dependency Updates: Latest security patches and improvements

πŸ’” Breaking Changes

  • Pydantic v2: May require code changes if extending the service
  • Python 3.12: Minimum Python version increased
  • Docker Images: New base images may affect custom deployments

πŸ—οΈ For Developers

  • GitHub Container Registry: Images now published to ghcr.io
  • Enhanced CI/CD: Automated testing and deployment
  • Better Documentation: Comprehensive guides for contribution

Original Author: M.B.C.M (PapiHack)