#ESW-384: Mausam : Update documents for 3.0.0 release

.github/workflows/release.yml

@@ -9,7 +9,7 @@ jobs:
   release:
     runs-on: ubuntu-18.04
     env:
-      ESW_TS_VERSION: "0.1.0-RC1"
+      ESW_TS_VERSION: "0.1.0"
     steps:
       - uses: actions/checkout@v2
       - uses: laughedelic/coursier-setup@v1

CHANGELOG.md

@@ -9,7 +9,7 @@ The product is in a new repository: [csw](https://github.com/tmtsoftware/csw).
 
 All notable changes to this project will be documented in this file.
 
-## [CSW v3.0.0] - UP-COMING
+## [CSW v3.0.0] - 2021-01-22
 
 This is the third major release of the TMT Common Software for project stakeholders.
 See [here](https://tmtsoftware.github.io/csw/3.0.0/) for a detailed documentation of this version of the CSW software.

INSTALL.md

@@ -12,21 +12,21 @@ which is also available for [Linux](https://adoptopenjdk.net/installation.html?v
 
 ## Building the Software
 
-To compile and install CSW locally, run:
+To publish CSW locally, run:
 
-    sbt publishLocal stage
+    sbt publishLocal
 
-This installs the software under `target/universal/stage`.
+After publishing, you can run CSW apps using coursier as described [here](https://tmtsoftware.github.io/csw/3.0.0/commons/apps.html)
 
-## Installing the documentation
+## Generating the documentation
 
-The CSW [paradox](https://developer.lightbend.com/docs/paradox/current/index.html) documentation can be installed with:
+The CSW [paradox](https://developer.lightbend.com/docs/paradox/current/index.html) documentation can be generated with:
 
     sbt clean makeSite
 
 This puts the documentation under `target/site` with the entry point at `target/site/csw/0.1.0-SNAPSHOT/index.html`.
 
-For more details on the sbt tasks, see the [online documentation](https://tmtsoftware.github.io/csw/1.0.0/commons/sbt-tasks.html).
+For more details on the sbt tasks, see the [online documentation](https://tmtsoftware.github.io/csw/3.0.0/commons/sbt-tasks.html).
 
 For information about making a CSW release, see [here](RELEASING.md).
 

README.md

@@ -12,7 +12,7 @@ See [here](https://tmtsoftware.github.io/csw/) for a detailed description of the
 
 | Date | Tag | Docs | Source | Download |
 |-----|-----|--------|-----|-----|
-| UP-COMING | v3.0.0 | [scala](https://tmtsoftware.github.io/csw/3.0.0/api/scala/index.html), [java](https://tmtsoftware.github.io/csw/3.0.0/api/java/index.html) | [csw-3.0.0](https://github.com/tmtsoftware/csw/tree/v3.0.0)| Apps: [zip](https://github.com/tmtsoftware/csw/releases/download/v3.0.0/csw-apps-3.0.0.zip), Source: [tar.gz](https://github.com/tmtsoftware/csw/archive/v3.0.0.tar.gz), [zip](https://github.com/tmtsoftware/csw/archive/v3.0.0.zip) |
+| 2021-01-22 | v3.0.0 | [scala](https://tmtsoftware.github.io/csw/3.0.0/api/scala/index.html), [java](https://tmtsoftware.github.io/csw/3.0.0/api/java/index.html) | [csw-3.0.0](https://github.com/tmtsoftware/csw/tree/v3.0.0)| Apps: [zip](https://github.com/tmtsoftware/csw/releases/download/v3.0.0/csw-apps-3.0.0.zip), Source: [tar.gz](https://github.com/tmtsoftware/csw/archive/v3.0.0.tar.gz), [zip](https://github.com/tmtsoftware/csw/archive/v3.0.0.zip) |
 | 2020-03-20 | v2.0.1 | [scala](https://tmtsoftware.github.io/csw/2.0.1/api/scala/index.html), [java](https://tmtsoftware.github.io/csw/2.0.1/api/java/index.html) | [csw-2.0.1](https://github.com/tmtsoftware/csw/tree/v2.0.1)| Apps: [zip](https://github.com/tmtsoftware/csw/releases/download/v2.0.1/csw-apps-2.0.1.zip), Source: [tar.gz](https://github.com/tmtsoftware/csw/archive/v2.0.1.tar.gz), [zip](https://github.com/tmtsoftware/csw/archive/v2.0.1.zip) |
 | 2020-03-19 | v2.0.0 | [scala](https://tmtsoftware.github.io/csw/2.0.0/api/scala/index.html), [java](https://tmtsoftware.github.io/csw/2.0.0/api/java/index.html) | [csw-2.0.0](https://github.com/tmtsoftware/csw/tree/v2.0.0)| Apps: [zip](https://github.com/tmtsoftware/csw/releases/download/v2.0.0/csw-apps-2.0.0.zip), Source: [tar.gz](https://github.com/tmtsoftware/csw/archive/v2.0.0.tar.gz), [zip](https://github.com/tmtsoftware/csw/archive/v2.0.0.zip) |
 | 2019-08-30 | v1.0.0 | [scala](https://tmtsoftware.github.io/csw/1.0.0/api/scala/index.html), [java](https://tmtsoftware.github.io/csw/1.0.0/api/java/index.html) | [csw-1.0.0](https://github.com/tmtsoftware/csw/tree/v1.0.0)| Apps: [zip](https://github.com/tmtsoftware/csw/releases/download/v1.0.0/csw-apps-1.0.0.zip), Source: [tar.gz](https://github.com/tmtsoftware/csw/archive/v1.0.0.tar.gz), [zip](https://github.com/tmtsoftware/csw/archive/v1.0.0.zip) |

RELEASING.md

@@ -18,18 +18,20 @@
 
 ### csw
 
-1. Update release notes (`notes/<version>.markdown`) in `csw` repo and link the migration guide
+1. Create a branch named `branch-<major>.<minor>.x` if not already exists from `master`. Example branch name `branch-3.0.x`.
+   All subsequent release for this release cycle should be done on this branch. All further steps are to be done on this branch.
+2. Update release notes (`notes/<version>.markdown`) in `csw` repo and link the migration guide
  **Note** - The version in `notes` should be of format `v1.0.0`
-2. Update top-level `CHANGELOG.md`
-3. Update top-level `README.md`
-4. Add changes mention in `CHANGELOG.md` of `csw-contract` in top-level `CHANGELOG.md`
-5. Add changes mention in `CHANGELOG.md` of `csw-contract` in the change section of `README.md` of `csw-contract`
-6. Add changes mention in `CHANGELOG.md` of `csw-contract` in top-level `README.md`
-7. Bump up the `csw-contract` version (if needed)
-8. Exclude projects from `build.sbt` which you do not want to release
-8. Update versions in `release.yml'` for other repos like `ESW_TS_VERSION` etc. which we will be releasing next. (These versions are used to create parameterized links in documentation)
-9. Commit and push the changes to master branch.
-10. Run `release.sh $VERSION$` script by providing version number argument (This triggers release workflow)
+3. Update top-level `CHANGELOG.md`
+4. Update top-level `README.md`
+5. Add changes mention in `CHANGELOG.md` of `csw-contract` in top-level `CHANGELOG.md`
+6. Add changes mention in `CHANGELOG.md` of `csw-contract` in the change section of `README.md` of `csw-contract`
+7. Add changes mention in `CHANGELOG.md` of `csw-contract` in top-level `README.md`
+8. Bump up the `csw-contract` version (if needed)
+9. Exclude projects from `build.sbt` which you do not want to release
+10. Update versions in `release.yml'` for other repos like `ESW_TS_VERSION` etc. which we will be releasing next. (These versions are used to create parameterized links in documentation)
+11. Commit and push the changes to `branch-<major>.<minor>.x` branch.
+12. Run `release.sh $VERSION$` script by providing version number argument (This triggers release workflow)
 
     **Note:** `PROD=true` environment variable needs to be set before running `release.sh`