From 68b0d686fdc6c79f409ff9a3651533e3a6225888 Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Bianchi Date: Fri, 9 Aug 2024 17:19:24 +0200 Subject: [PATCH 1/2] Added a blog post about the legacy branch of the TS SDK Signed-off-by: Jean-Baptiste Bianchi --- .../releases/release-sdk-typescript-legacy.md | 50 +++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 content/en/blog/releases/release-sdk-typescript-legacy.md diff --git a/content/en/blog/releases/release-sdk-typescript-legacy.md b/content/en/blog/releases/release-sdk-typescript-legacy.md new file mode 100644 index 0000000..5c76ca4 --- /dev/null +++ b/content/en/blog/releases/release-sdk-typescript-legacy.md @@ -0,0 +1,50 @@ +--- +title: Serverless Workflow TypeScript SDK Legacy +author: Jean-Baptiste Bianchi +date: 2024-08-09 +description: > + Legacy Branch & Release for the TypeScript SDK +--- + +# Announcing the Legacy Branch & release for Serverless Workflow TypeScript SDK + +Hello, Serverless Workflow community! + +I'm excited to share some important updates regarding the TypeScript SDK for the Serverless Workflow specification. As many of you know, our specification underwent a significant rewrite after version 0.9, culminating in the anticipated release of version 1.0.0-alpha. This update will bring many improvements and changes, aligning the spec with the latest needs and trends in serverless architectures. + +## Introducing the Legacy Branch + +For those of you who have been working with version 0.9 of the spec and wish to continue using it, we've created a **legacy branch** in our GitHub repository. This branch is for developers who want to maintain the older version, even though our organization will not officially support it moving forward. + +You can find the legacy branch here: [Serverless Workflow TypeScript SDK - Legacy spec 0.9 Branch](https://github.com/serverlessworkflow/sdk-typescript/tree/legacy-spec-0.9) + +### NPM Package for the Legacy Version + +The legacy branch is published under the previously erroneous organization name `@severlessworkflow`. This package is available for those needing the older version for compatibility reasons and is aligned with version 0.9 of the specification. + +To install the legacy package, you can use: + +```bash +npm install @severlessworkflow/sdk-typescript@4.0.0-rc1 +``` + +This package will retain the older naming and organizational structure to maintain backward compatibility for existing projects. + +## Upcoming Packages with Correct Naming + +Moving forward, all new packages will be released under the correct (organization) name `@serverlessworkflow/sdk`. This change not only corrects a previous error but also aligns with the updated versioning of the spec. + +The version 1.0.0-alpha of the package is still a [work in progress](https://github.com/serverlessworkflow/sdk-typescript/pull/188) and will be released once it is ready, featuring all the enhancements and updates introduced with the rewritten specification. + + +## Why This Matters + +These changes ensure that we are consistent and aligned with our community's expectations and standards. By maintaining a legacy branch, we are providing a bridge for developers who may need more time to transition to the new specification. At the same time, the correct naming and versioning for new packages help streamline our offerings and reduce confusion. + +## Moving Forward + +I encourage all developers to explore the new features and improvements of the upcoming SDK version once it is released. For those who need to stick with the older version for now, the legacy branch is there for your convenience. + +Thank you for your continued support and contributions to the Serverless Workflow community. As always, your feedback is invaluable, and I look forward to hearing your thoughts on these changes. + +Happy coding! \ No newline at end of file From 14c6420162f1d1631d2be7a20385589735eeb36b Mon Sep 17 00:00:00 2001 From: JBBianchi Date: Mon, 12 Aug 2024 17:16:04 +0200 Subject: [PATCH 2/2] Updated phrasing in blog post Signed-off-by: Jean-Baptiste Bianchi --- .../en/blog/releases/release-sdk-typescript-legacy.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/content/en/blog/releases/release-sdk-typescript-legacy.md b/content/en/blog/releases/release-sdk-typescript-legacy.md index 5c76ca4..9702453 100644 --- a/content/en/blog/releases/release-sdk-typescript-legacy.md +++ b/content/en/blog/releases/release-sdk-typescript-legacy.md @@ -34,17 +34,16 @@ This package will retain the older naming and organizational structure to mainta Moving forward, all new packages will be released under the correct (organization) name `@serverlessworkflow/sdk`. This change not only corrects a previous error but also aligns with the updated versioning of the spec. -The version 1.0.0-alpha of the package is still a [work in progress](https://github.com/serverlessworkflow/sdk-typescript/pull/188) and will be released once it is ready, featuring all the enhancements and updates introduced with the rewritten specification. - +The version 1.0.0-alpha is still a [work in progress](https://github.com/serverlessworkflow/sdk-typescript/pull/188). It will be released once it is ready and will feature all the enhancements and updates introduced with the rewritten specification. ## Why This Matters -These changes ensure that we are consistent and aligned with our community's expectations and standards. By maintaining a legacy branch, we are providing a bridge for developers who may need more time to transition to the new specification. At the same time, the correct naming and versioning for new packages help streamline our offerings and reduce confusion. +These changes ensure consistency and alignment with our community's expectations and standards. Maintaining a legacy branch provides a bridge for developers needing more time to transition to the new specification. At the same time, the correct naming and versioning for new packages help streamline our offerings and reduce confusion. ## Moving Forward -I encourage all developers to explore the new features and improvements of the upcoming SDK version once it is released. For those who need to stick with the older version for now, the legacy branch is there for your convenience. +We encourage all developers to explore the new features and improvements of the upcoming SDK version once it is released. For those who need to stick with the older version for now, the legacy branch is there for your convenience. -Thank you for your continued support and contributions to the Serverless Workflow community. As always, your feedback is invaluable, and I look forward to hearing your thoughts on these changes. +Thank you for your continued support and contributions to the Serverless Workflow community. As always, your feedback is invaluable, and we look forward to hearing your thoughts on these changes. Happy coding! \ No newline at end of file