preparing release v5.0.0-RC1

.github/workflows/release.yml

@@ -9,7 +9,7 @@ jobs:
   release:
     runs-on: ubuntu-latest
     env:
-      ESW_TS_VERSION: "0.3.0"
+      ESW_TS_VERSION: "0.4.0-RC1"
     steps:
       - uses: actions/checkout@v2
       - uses: coursier/[email protected]

CHANGELOG.md

@@ -11,14 +11,24 @@ All notable changes to this project will be documented in this file.
 
 ## Upcoming releases
 
+## [CSW v5.0.0-RC1] - 2022-09-14
+This is a release candidate 1 for version 5.0.0 of the TMT Common Software for project stakeholders.
+See [here](https://tmtsoftware.github.io/csw/5.0.0-RC1/) for a detailed documentation of this version of the CSW software.
+
+### Changes
 - Upgrade the project to jdk 17 (Update the INSTALL.md)
-- Add `nanometers` to Units
+- Added missing standard units
 - [Breaking] ComponentInfo now takes componentHandlerClassName instead of behaviorFactoryClassName.
   Follow migration guide(https://tmtsoftware.github.io/csw/migration_guide/migration_guide_4.0.0_to_5.0.0/migration-guide-4.0.0-to-5.0.0.html)
-- Starting Component in standalone or container mode is automatically derived based on config structure. So, 
-  - When using ContainerCmd App, used don't need to provide `--standalone` option anymore.
+- Starting Component in standalone or container mode is automatically derived based on config structure. So,
+    - When using ContainerCmd App, used don't need to provide `--standalone` option anymore.
 - Added `OffsetStart`, `OffsetEnd`, `InputRequestStart` & `InputRequestEnd` in Sequencer Observe Events.
 
+### Documentation
+- Reference paradox documentation: https://tmtsoftware.github.io/csw/5.0.0-RC1/
+- Scaladoc: https://tmtsoftware.github.io/csw/5.0.0-RC1/api/scala/index.html
+- Javadoc: https://tmtsoftware.github.io/csw/5.0.0-RC1/api/java/index.html
+
 ## [CSW v4.0.1] - 2022-02-09
 This is final release v4.0.1 of the TMT Common Software for project stakeholders.
 See [here](https://tmtsoftware.github.io/csw/4.0.1/) for a detailed documentation of this version of the CSW software.

INSTALL.md

@@ -5,10 +5,16 @@
 * The CSW software is build using [sbt](https://www.scala-sbt.org).
 Be sure to install the latest version and add it to your shell path.
 
-* This version of CSW also requires [Java-11](https://openjdk.java.net/projects/jdk/11/).
-On Linux systems java can be installed using the standard tools (`yum` on CentOS, `dnf` on Fedora, `apt` on Ubuntu, etc.).
-On Macs, you can use [AdoptOpenJDK](https://github.com/AdoptOpenJDK/homebrew-openjdk),
-which is also available for [Linux](https://adoptopenjdk.net/installation.html?variant=openjdk11&jvmVariant=hotspot#x64_linux-jdk).
+* This version of CSW also requires [Java-17](https://openjdk.java.net/projects/jdk/17/).
+
+## Upgrading to Java 17
+
+If you have Java installed via Coursier then follow these instructions:
+- Re-install `cs` as described in [Coursier installation](https://get-coursier.io/docs/cli-installation#native-launcher) (this will make sure that jvm-indexes are updated).
+- Run the following command `cs java --jvm temurin:1.17` - this will upgrade Java to version 17.
+- Once Java is upgraded include command `eval $(cs java --jvm temurin:1.17 --env)` in your respective shell profiles (this will set the required environment variables (e.g., JAVA_HOME) into your shell).
+
+If you want to install Java 17 manually - the binary package for macOS or Linux can be downloaded from [Adoptium Temurin releases](https://adoptium.net/temurin/releases).
 
 ## Building the Software