From 3142a99363011d92fdb3b854adf3f763fe830292 Mon Sep 17 00:00:00 2001 From: Duc Trung Le Date: Mon, 11 Mar 2024 10:28:57 +0100 Subject: [PATCH] Add 1.0.0 highlights to the change log (#76) --- CHANGELOG.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 45a7109..489c392 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,61 @@ # tljh-repo2docker Changelog +## 1.0.0 - Highlights + +The purpose of this release is to allow for better compatibility of the plugin with different versions of The Littlest JupyterHub. + +This plugin was initially developed for a previous version of TLJH when it was not versioned yet. Now TLJH is making proper releases and might start introducing new changes that might potentially be breaking. + +In short: + +- Use `v1.0.0` if you are using a version of TLJH that includes JupyterHub 1. +- A future major version (`v2`) of the `tljh-repo2docker` plugin will target TLJH 1.0 and JupyterHub 4 as minimal requirements. + +:information_source: Note the current `v1.0.0` version should already be compatible with JupyterHub 4. + +You can find below the list of changes since the creation of the plugin. + +## What's Changed + +* Add installation instructions to the README by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/1 +* Fix manifest by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/2 +* Add optional name to the environment by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/7 +* Show more information on the spawner options page by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/10 +* Add minimal documentation to the README by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/11 +* Update README instructions to install the plugin by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/12 +* Expose list_images by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/13 +* Show human readable value for mem and cpu limits by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/16 +* Rename from PlasmaBio to Plasma by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/17 +* Add a simple CI workflow by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/18 +* Replace the service by extra hub handlers by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/19 +* Add tests by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/21 +* Show the build logs in a dialog by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/22 +* Lowercase the autogenerated name from the repo by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/23 +* Package the tests by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/25 +* Async start method in the default spawner by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/28 +* Hide 'Cancel' button from logs window by @pierrepo in https://github.com/plasmabio/tljh-repo2docker/pull/33 +* Update instead of overwrite extra_host_config by @TimoRoth in https://github.com/plasmabio/tljh-repo2docker/pull/34 +* Await rendered template if neccesary by @TimoRoth in https://github.com/plasmabio/tljh-repo2docker/pull/40 +* Pin dependencies by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/41 +* Add support for GIT_CREDENTIAL_ENV to build private repos by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/42 +* Update repo2docker image by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/49 +* Pin to `jupyterhub~=1.5` for development, update `dockerspawner`, default ref to `HEAD` by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/50 +* Update Python versions on CI by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/51 +* Use --label to set labels by @TimoRoth in https://github.com/plasmabio/tljh-repo2docker/pull/48 +* Expose custom build-args as advanced option in the UI by @TimoRoth in https://github.com/plasmabio/tljh-repo2docker/pull/52 +* Update test binder repo to the new URL by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/53 +* Rename test repo to `tljh-repo2docker-test-binder` by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/54 +* Pin `notebook<7` and `sqlalchemy<2` for now by @jtpio in https://github.com/plasmabio/tljh-repo2docker/pull/62 +* Resolve 'Show Logs' issue by adding _xsrf token by @yamaton in https://github.com/plasmabio/tljh-repo2docker/pull/61 + +## New Contributors +* @jtpio made their first contribution in https://github.com/plasmabio/tljh-repo2docker/pull/1 +* @pierrepo made their first contribution in https://github.com/plasmabio/tljh-repo2docker/pull/33 +* @TimoRoth made their first contribution in https://github.com/plasmabio/tljh-repo2docker/pull/34 +* @yamaton made their first contribution in https://github.com/plasmabio/tljh-repo2docker/pull/61 + +**Full Changelog**: https://github.com/plasmabio/tljh-repo2docker/commits/v1 +