Automate Cadence release data onto documentation (#217)

Author: ibarrajo

.github/workflows/fetch-release-data.yml

@@ -0,0 +1,30 @@
+name: Fetch release data
+on:
+  schedule:
+    # Run every 8 hours
+    - cron: '0 */8 * * *'
+  workflow_dispatch:
+permissions:
+  contents: write
+jobs:
+  fetch-release-data:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          sparse-checkout: |
+            scripts
+            static/data/releases
+      - run: |
+            ./scripts/fetch-releases.sh
+            if git diff --quiet static/data/releases; then
+              echo "No changes to commit"
+              exit 0
+            fi
+            git config user.name "github-actions[bot]"
+            git config user.email "github-actions[bot]@users.noreply.github.com"
+            git add static/data/releases
+            git commit -m "Update release data"
+            git push
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -62,6 +62,11 @@ $ GIT_USER=<Your GitHub username> npm run deploy
 If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
 
 
+### Updating Release Data
+
+The release pages rely on data from GitHub that is persisted as json files under `static/data/releases/`.
+In order to update the release information for display, this can be done manually or be set up as part of the CI/CD process by running the `scripts/fetch-releases.sh` script. Script uses the [GitHub CLI](https://cli.github.com/) to fetch the release data.
+
 # NPM Registry
 
 Ensure you have a `.npmrc` [file](https://docs.npmjs.com/cli/v9/configuring-npm/npmrc/) configured with `registry=https://registry.npmjs.org/`.

docs/01-get-started/02-java-hello-world.md

@@ -14,14 +14,15 @@ You can also review [Java-Client](/docs/java-client) and [java-docs](https://www
 
 ## Include Cadence Java Client Dependency
 
-Go to the [Maven Repository Uber Cadence Java Client Page](https://mvnrepository.com/artifact/com.uber.cadence/cadence-client)
-and find the latest version of the library. Include it as a dependency into your Java project. For example if you
-are using Gradle the dependency looks like:
-```bash
+Custom snippets for including the Cadence Java Client can be found in the [cadence-client](https://central.sonatype.com/artifact/com.uber.cadence/cadence-client) page on Maven Central. Latest version is available in the [Cadence Java Client Releases](/docs/releases/cadence-java-client) page
+
+Include the cadence-client as a dependency into your Java project. For example if you
+are using Gradle, the dependency looks like:
+```gradle
 implementation group: 'com.uber.cadence', name: 'cadence-client', version: '<latest_version>'
 ```
 Also add the following dependencies that cadence-client relies on:
-```bash
+```gradle
 implementation group: 'commons-configuration', name: 'commons-configuration', version: '1.9'
 implementation group: 'ch.qos.logback', name: 'logback-classic', version: '1.2.3'
 ```

docs/09-releases/cadence-go-client.mdx

@@ -0,0 +1,28 @@
+---
+layout: default
+title: Cadence Go Client Releases
+description: Release Notes
+permalink: /docs/releases/cadence-go-client
+---
+
+# Cadence Go Client
+
+import {ListReleases, getReleaseData, getLatestRelease} from  '@site/src/components/CadenceReleases';
+export const releases = getReleaseData('cadence-go-client.json');
+export const latestRelease = getLatestRelease(releases);
+
+
+Cadence follows [semantic versioning](https://semver.org/spec/v2.0.0.html) and you can find more information about changes between version on the Cadence [changelog](https://github.com/cadence-workflow/cadence/blob/master/CHANGELOG.md).
+
+:::tip[Latest release for General Availability]
+
+> <strong><a href={latestRelease.html_url} target="_blank">{latestRelease.name}</a> </strong>published on {latestRelease.published_at_date}
+
+:::
+
+## Major Releases
+<ListReleases releases={releases}></ListReleases>
+
+---
+
+For a comprehensive list of changes and detailed release notes, please visit the [Cadence Go Client GitHub Releases page](https://github.com/cadence-workflow/cadence-go-client/releases).

docs/09-releases/cadence-java-client.mdx

@@ -0,0 +1,39 @@
+---
+layout: default
+title: Cadence Java Client Releases
+description: Release Notes
+permalink: /docs/releases/cadence-java-client
+---
+
+# Cadence Java Client
+
+import {ListReleases, getReleaseData, getLatestRelease} from  '@site/src/components/CadenceReleases';
+export const releases = getReleaseData('cadence-java-client.json');
+export const latestRelease = getLatestRelease(releases);
+
+
+Cadence follows [semantic versioning](https://semver.org/spec/v2.0.0.html) and you can find more information about changes between version on the Cadence [changelog](https://github.com/cadence-workflow/cadence/blob/master/CHANGELOG.md).
+
+:::tip[Latest release for General Availability]
+
+> <strong><a href={latestRelease.html_url} target="_blank">{latestRelease.name}</a> </strong>published on {latestRelease.published_at_date}
+
+:::
+
+:::info[Java Compatibility]
+
+Java versions 21, 17 and 11 are supported at this time.
+
+Due to backward compatibility, Java versions 17+ require the following JVM flag
+```
+--add-opens java.base/java.lang=ALL-UNNAMED
+```
+
+:::
+
+## Major Releases
+<ListReleases releases={releases}></ListReleases>
+
+---
+
+For a comprehensive list of changes and detailed release notes, please visit the [Cadence Java Client GitHub Releases page](https://github.com/cadence-workflow/cadence-java-client/releases).

docs/09-releases/cadence.mdx

@@ -0,0 +1,30 @@
+---
+layout: default
+title: Cadence Service Releases
+description: Release Notes
+permalink: /docs/releases
+---
+
+import {
+  ListReleases,
+  getReleaseData,
+  getLatestRelease,
+} from "@site/src/components/CadenceReleases";
+
+export const releases = getReleaseData("cadence.json");
+export const latestRelease = getLatestRelease(releases);
+
+Cadence follows [semantic versioning](https://semver.org/spec/v2.0.0.html) and you can find more information about changes between version on the Cadence [changelog](https://github.com/cadence-workflow/cadence/blob/master/CHANGELOG.md).
+
+:::tip[Latest release for General Availability]
+
+> <strong><a href={latestRelease.html_url} target="_blank">{latestRelease.name}</a> </strong>published on {latestRelease.published_at_date}
+
+:::
+
+## Major Releases
+<ListReleases releases={releases}></ListReleases>
+
+---
+
+For a comprehensive list of changes and detailed release notes, please visit the [Cadence GitHub Releases page](https://github.com/cadence-workflow/cadence/releases).

docs/09-about/01-license.md renamed to docs/10-about/01-license.md

@@ -1,6 +1,6 @@
 {
   "name": "cadence",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -26,18 +26,22 @@
     "@docusaurus/preset-classic": "^3.7.0",
     "@docusaurus/remark-plugin-npm2yarn": "^3.7.0",
     "@docusaurus/theme-search-algolia": "^3.7.0",
+    "@iconify/react": "^5.2.0",
     "@mdx-js/react": "^3.0.0",
     "@pnpm/config.env-replace": "^3.0.0",
     "clsx": "^2.0.0",
+    "lodash": "^4.17.21",
     "prism-react-renderer": "^2.3.0",
     "react": "^18.0.0",
     "react-dom": "^18.0.0",
+    "react-markdown": "^9.0.3",
     "remark-math": "^6.0.0"
   },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "^3.7.0",
     "@docusaurus/tsconfig": "^3.7.0",
     "@docusaurus/types": "^3.7.0",
+    "@types/lodash": "^4.17.15",
     "typescript": "~5.6.2"
   },
   "browserslist": {