Skip to content

Commit

Permalink
Merge pull request educates#186 from GrahamDumpleton/release-notes
Browse files Browse the repository at this point in the history
Add release notes for changes made.
  • Loading branch information
GrahamDumpleton authored Oct 11, 2023
2 parents 5ee7c6d + b95a4a2 commit a1ab8d7
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
1 change: 1 addition & 0 deletions project-docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ Educates
:maxdepth: 2
:caption: Release Notes:

release-notes/version-2.6.16
release-notes/version-2.6.15
release-notes/version-2.6.14
release-notes/version-2.6.13
Expand Down
37 changes: 37 additions & 0 deletions project-docs/release-notes/version-2.6.16.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
Version 2.6.16
==============

New Features
------------

* In special case where the workshop base image was being used to run services
in a separate deployment from the workshop pod, using the default command for
the image, it is now possible to set the `SUPERVISOR_ONLY` environment
variable. This will have the affect of ensuring the gateway process which runs
the workshop dashboard, and other processes such as the editor and console are
not run, unless explicitly enabled by respective environment variables.
Further, in this mode, if an error occurs in downloading files using `vendir`
or when running setup scripts, the start script for the container will be
exited, with the result that the pod will be restarted, instead of ignoring
the errors and continuing on to running the process supervisor.

Features Changed
----------------

* Examiner functionality was incorrectly enabled by default in the workshop base
image. If a workshop had inadvertantly been making use of this it may now
fail, in which case it should explicitly enable the examiner feature in the
workshop defintion as was originally intended to be done.

* If the Hugo renderer is being used, and there are no workshop instructions
or an error occurs when rendering the instructions, a default page will be
shown in the workshop instructions with a warning that an error occurred,
rather than showing a HTTP page not found error.

Bugs Fixed
----------

* When an error occured rendering workshop instructions using the Hugo renderer,
the details were not logged to the `setup-scripts.log` file accessible from
inside of the workshop container, and were only visible by using `kubectl log`
on the pod corresponding to the workshop container.

0 comments on commit a1ab8d7

Please sign in to comment.