Skip to content

RELEASE_TEMPLATE.md

Latest commit

 

History

History
103 lines (82 loc) · 2.16 KB

RELEASE_TEMPLATE.md

File metadata and controls

103 lines (82 loc) · 2.16 KB

Release Notes Template

🚀 {ENV_NAME} Release v{VERSION}

Version Information

  • Version: {VERSION}
  • Date: {DATE}
  • Type: {ENV_NAME} ({ENV_TYPE})
  • Build: {BUILD_NUMBER}

✨ Highlights

🔄 What's New

🐛 Bug Fixes

📈 Improvements

🔧 Technical Changes

🐳 Docker Images

Pull this release:

docker pull ghcr.io/pierregrothe/graphrag-api:{VERSION}

Latest {ENV_NAME} image:

docker pull ghcr.io/pierregrothe/graphrag-api:{LATEST_TAG}

📦 Quick Start

Using Docker Run:

docker run -d \
  --name graphrag-api \
  -p 8001:8001 \
  -e JWT_SECRET_KEY="change-this-in-production" \
  -e LLM_PROVIDER="ollama" \
  -e OLLAMA_BASE_URL="http://host.docker.internal:11434" \
  ghcr.io/pierregrothe/graphrag-api:{VERSION}

Using Docker Compose:

services:
  graphrag-api:
    image: ghcr.io/pierregrothe/graphrag-api:{VERSION}
    container_name: graphrag-api
    ports:
      - "8001:8001"
    environment:
      - JWT_SECRET_KEY=change-this-in-production
      - LLM_PROVIDER=ollama
      - OLLAMA_BASE_URL=http://ollama:11434
    volumes:
      - ./data:/app/data
      - ./workspaces:/app/workspaces

🔗 Links

📋 Compatibility

  • Python: 3.12+
  • Platforms: {PLATFORMS}
  • LLM Providers: Ollama, Google Gemini
  • Authentication: JWT, API Keys

⚠️ Breaking Changes

None in this release.

🚀 Migration Guide

No migration required from previous versions.

📝 Notes

{RELEASE_NOTES}

🙏 Contributors

  • @pierregrothe

Full Changelog: Compare View