From c06f89b6ba5cfdd2bb87a9587e50726d464bb209 Mon Sep 17 00:00:00 2001 From: Sebastian Bathke Date: Fri, 6 Sep 2024 17:37:40 +0200 Subject: [PATCH] Announce Go client & zbctl deprecation (#4264) * Announce Go client & zbctl deprecation * Improved wording on zeebe go client deprecation announcement Co-authored-by: Mark Sellings * Improved language on Go client deprecation announcement Co-authored-by: Mark Sellings * Add deprecation announcement to all go-client pages * Revised lang on go client deprecation announcement Co-authored-by: Aleksander Dytko <102789122+aleksander-dytko@users.noreply.github.com> --------- Co-authored-by: Mark Sellings Co-authored-by: Aleksander Dytko <102789122+aleksander-dytko@users.noreply.github.com> --- docs/apis-tools/go-client/go-get-started.md | 6 ++++++ docs/apis-tools/go-client/index.md | 8 +++++++- docs/apis-tools/go-client/job-worker.md | 6 ++++++ docs/reference/announcements.md | 21 ++++----------------- sidebars.js | 2 +- 5 files changed, 24 insertions(+), 19 deletions(-) diff --git a/docs/apis-tools/go-client/go-get-started.md b/docs/apis-tools/go-client/go-get-started.md index 4943d5f500..fb5022467e 100644 --- a/docs/apis-tools/go-client/go-get-started.md +++ b/docs/apis-tools/go-client/go-get-started.md @@ -7,6 +7,12 @@ sidebar_label: "Getting started with the Go client" import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; +:::caution + +The Zeebe Go client will be officially deprecated with the 8.6 release. For more information, see [announcements](../../../reference/announcements/#deprecation-zeebe-go-client--zbctl). + +::: + In this tutorial, you will learn how to use the Go client in a Go application to interact with Camunda 8. You can find a complete example on [GitHub](https://github.com/camunda/camunda-platform-get-started/tree/main/go). diff --git a/docs/apis-tools/go-client/index.md b/docs/apis-tools/go-client/index.md index b5ecd89365..e006122699 100644 --- a/docs/apis-tools/go-client/index.md +++ b/docs/apis-tools/go-client/index.md @@ -1,10 +1,16 @@ --- id: index -title: "Go client" +title: "Go client (Deprecated)" sidebar_label: "Quick reference" description: "Instantiate the client by passing in the address of the cluster you want to connect to in a Go application to interact with Camunda 8." --- +:::caution + +The Zeebe Go client will be officially deprecated with the 8.6 release. For more information, see [announcements](../../reference/announcements/#deprecation-zeebe-go-client--zbctl). + +::: + ## Dependencies To use the [Zeebe Go client library](https://github.com/camunda/camunda-platform-get-started/tree/main/go), add the following dependency to your `go.mod`: diff --git a/docs/apis-tools/go-client/job-worker.md b/docs/apis-tools/go-client/job-worker.md index 58ff305ee8..d342ffab8d 100644 --- a/docs/apis-tools/go-client/job-worker.md +++ b/docs/apis-tools/go-client/job-worker.md @@ -5,6 +5,12 @@ description: "Let's take a deeper look at job workers to handle jobs." keywords: ["backpressure", "back-pressure", "back pressure"] --- +:::caution + +The Zeebe Go client will be officially deprecated with the 8.6 release. For more information, see [announcements](../../../reference/announcements/#deprecation-zeebe-go-client--zbctl). + +::: + The Go client provides a job worker that handles both polling and streaming for available jobs. This allows you to focus on writing code to handle the activated jobs. On `Open`, the job worker waits `PollInterval` milliseconds and then polls for `MaxJobsActive` jobs. It then continues with the following schedule: diff --git a/docs/reference/announcements.md b/docs/reference/announcements.md index 2c1424e8b0..ec11105fc5 100644 --- a/docs/reference/announcements.md +++ b/docs/reference/announcements.md @@ -50,6 +50,10 @@ The Zeebe Java client will not be developed further and will only receive bug fi - **Artifact ID change**: - The `artifactId` will change from `zeebe-client-java` to `camunda-client-java`. +### Deprecation: Zeebe Go client & zbctl + +The Zeebe Go Client and zbctl will be officially deprecated with the 8.6 release as part of our efforts to streamline the Camunda 8 API experience. This client and CLI utility will not get released starting with Camunda 8.6, will no longer receive new features, and will be transitioned to a community-maintained status. + ### Camunda 8 SaaS - Required cluster update :::caution @@ -77,23 +81,6 @@ If you do not update the cluster by August 30th 2024, we will update the cluster Camunda 8 Self-Managed clusters are not affected by this. -### Zeebe repo rename impacts Go client - -The Camunda 8 Github repository was renamed from `http://github.com/camunda/zeebe` to `http://github.com/camunda/camunda`, impacting the Zeebe Go client path. - -Starting in 8.6.0, the Zeebe Go client path should reflect the renamed repo as follows: - -```go - -module example.com/mymodule - -require ( - github.com/camunda/camunda/clients/go/v8 v8.x.y - ... -) - -``` - ### Supported environment changes (OpenJDK, ElasticSearch, Amazon OpenSearch) Version changes are made to supported environments: diff --git a/sidebars.js b/sidebars.js index cceb20a30e..eddb69eb7e 100644 --- a/sidebars.js +++ b/sidebars.js @@ -802,7 +802,7 @@ module.exports = { ], }, { - "Go client": [ + "Go client (Deprecated)": [ "apis-tools/go-client/index", "apis-tools/go-client/go-get-started", "apis-tools/go-client/job-worker",