|
| 1 | +# Changelog |
| 2 | + |
| 3 | +All notable changes to the Docker image in this directory will be documented in this file. |
| 4 | + |
| 5 | +The format is loosely based on Keep a Changelog and tracks changes to the Dockerfile, |
| 6 | +bundled notebooks, and image-facing documentation. |
| 7 | + |
| 8 | +The format is based on [Keep a Changelog](http://keepachangelog.com/) |
| 9 | +and this project adheres to [Semantic Versioning](http://semver.org/). |
| 10 | + |
| 11 | +## [0.7.0] - 2026-03-22 |
| 12 | + |
| 13 | +### Added |
| 14 | + |
| 15 | +- Added a Rust Jupyter notebook at `docker/notebooks/openrust_basic.ipynb` based on the |
| 16 | + OpEn basic Rust example. |
| 17 | +- Added a Python Jupyter notebook at `docker/notebooks/python_ocp_1.ipynb` based on the |
| 18 | + getting-started optimal control example. |
| 19 | +- Added Matplotlib to the image so bundled Python notebooks can plot trajectories. |
| 20 | +- Added Rust kernel support in JupyterLab through `evcxr_jupyter`. |
| 21 | + |
| 22 | +### Changed |
| 23 | + |
| 24 | +- Updated the image to bundle Python 3.12 from `python:3.12-slim-bookworm`. |
| 25 | +- Switched the interactive environment from the classic Jupyter notebook UI to JupyterLab. |
| 26 | +- Moved the example notebook into `docker/notebooks/`. |
| 27 | +- Updated `docker/README.md` and `docs/docker.md` to describe the current image layout, |
| 28 | + authentication model, kernels, notebook locations, and build flow. |
| 29 | +- Documented the Dockerfile/image version separately from the bundled Python package |
| 30 | + version. |
| 31 | + |
| 32 | +### Security |
| 33 | + |
| 34 | +- Enabled Jupyter's default token authentication by default instead of disabling auth. |
| 35 | +- Upgraded `pip` in both the system Python and virtual environment during the image build. |
| 36 | +- Removed the transient `py` package from the virtual environment after installing |
| 37 | + `opengen`. |
| 38 | + |
| 39 | +## [0.6.0] - 2026-03-21 |
| 40 | + |
| 41 | +### Changed |
| 42 | + |
| 43 | +- Updated the Docker image version from `0.5.0` to `0.6.0` |
| 44 | +- Updated Python notebook |
| 45 | + |
| 46 | +## [0.5.0] - 2026-03-21 |
| 47 | + |
| 48 | +### Added |
| 49 | + |
| 50 | +- Added maintainer-facing build and publish instructions in `docker/README.md`. |
| 51 | + |
| 52 | +### Changed |
| 53 | + |
| 54 | +- Defined Dockerfile/image version `0.5.0`. |
| 55 | +- Bundled `opengen==0.10.0` in the image while keeping the Docker image version distinct. |
| 56 | +- Reworked notebook packaging so bundled notebooks are copied from `docker/notebooks/`. |
| 57 | + |
0 commit comments