Skip to content

release-notes.md

Latest commit

 

History

History
207 lines (166 loc) · 23.2 KB

release-notes.md

File metadata and controls

207 lines (166 loc) · 23.2 KB
Raw

Release Notes

Latest Changes

Upgrades

Docs

  • 📝 Deprecate this Docker image, use Uvicorn with --workers ✨. PR #303 by @tiangolo.
  • 📝 Add security policy. PR #283 by @tiangolo.

Internal

0.8.0

Features

  • ✨ Add support for multi-arch builds, including support for arm64 (e.g. Mac M1). PR #273 by @tiangolo.

Docs

Upgrades

Internal

0.7.0

Highlights of this release:

  • Support for Python 3.10 and 3.11.
  • Deprecation of Python 3.6.
    • The last Python 3.6 image tag was pushed and is available in Docker Hub, but it won't be updated or maintained anymore.
    • The last image with a date tag is python3.6-2022-11-25.
  • Upgraded versions of all the dependencies.

Features

  • ✨ Add support for Python 3.10 and 3.11. PR #220 by @tiangolo.
  • ✨ Add Python 3.9 and Python 3.9 Alpine. PR #67 by @graue70.

Breaking Changes

Upgrades

  • ⬆️ Upgrade FastAPI and Uvicorn versions. PR #212 by @tiangolo.
  • ⬆️ Upgrade packages to the last version that supports Python 3.6. PR #207 by @tiangolo.

Docs

  • 📝 Add note to discourage Alpine with Python. PR #122 by @tiangolo.
  • 📝 Add warning for Kubernetes, when to use this image. PR #121 by @tiangolo.
  • ✏ Fix typo, repeated word on README. PR #96 by @shelbylsmith.

Internal

0.6.0

  • Add docs about installing and pinning dependencies. PR #41.
  • Add slim version. PR #40.
  • Update and refactor bringing all the new features from the base image. Includes:
    • Centralize, simplify, and deduplicate code and setup
    • Move CI to GitHub actions
    • Add Python 3.8 (and Alpine)
    • Add new configs and docs:
      • WORKER_CLASS
      • TIMEOUT
      • KEEP_ALIVE
      • GRACEFUL_TIMEOUT
      • ACCESS_LOG
      • ERROR_LOG
      • GUNICORN_CMD_ARGS
      • MAX_WORKERS
    • PR #39.
  • Disable pip cache during installation. PR #38.
  • Migrate local development from Pipenv to Poetry. PR #34.
  • Add docs for custom PRE_START_PATH env var. PR #33.

0.5.0

  • Refactor tests to use env vars and add image tags for each build date, like tiangolo/uvicorn-gunicorn-fastapi:python3.7-2019-10-15. PR #17.
  • Upgrade Travis. PR #9.

0.4.0

  • Add support for live auto-reload with an additional custom script /start-reload.sh, check the updated documentation. PR #6 in parent image.

0.3.0

  • Set WORKERS_PER_CORE by default to 1, as it shows to have the best performance on benchmarks.
  • Make the default web concurrency, when WEB_CONCURRENCY is not set, to a minimum of 2 workers. This is to avoid bad performance and blocking applications (server application) on small machines (server machine/cloud/etc). This can be overridden using WEB_CONCURRENCY. This applies for example in the case where WORKERS_PER_CORE is set to 1 (the default) and the server has only 1 CPU core. PR #6 and PR #5 in parent image.

0.2.0

  • Make /start.sh run independently, reading and generating used default environment variables. And remove /entrypoint.sh as it doesn't modify anything in the system, only reads environment variables. PR #4 in parent image.

0.1.0

  • Add support for /app/prestart.sh.