Skip to content

Deprecate unmaintained CLIs and remove documentation generation#1940

Merged
tdeekens merged 10 commits intomasterfrom
td/deprecate-clis
Mar 24, 2025
Merged

Deprecate unmaintained CLIs and remove documentation generation#1940
tdeekens merged 10 commits intomasterfrom
td/deprecate-clis

Conversation

@tdeekens
Copy link
Contributor

@tdeekens tdeekens commented Mar 20, 2025

Summary

We will continue to support the CLIs in this repository.

This change we will undertake to achieve this is:

  1. Add a deprecation notice to all packages with a reference to the source code
  2. Remove the non functioning documentation generation
  3. Packages remain available on NPM

This leaves us in this repository with: sync-actions, personal-data-erasure, resource-deleter and the leagcy SDK. For these we should evaluate other strategies e.g. to move them to the TypeScript SDK.

@changeset-bot
Copy link

changeset-bot bot commented Mar 20, 2025

⚠️ No Changeset found

Latest commit: ba46de3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codecov
Copy link

codecov bot commented Mar 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.54%. Comparing base (7bc3a9a) to head (ba46de3).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1940      +/-   ##
==========================================
+ Coverage   97.76%   98.54%   +0.78%     
==========================================
  Files         147      109      -38     
  Lines        4786     2886    -1900     
  Branches     1283      833     -450     
==========================================
- Hits         4679     2844    -1835     
+ Misses        104       40      -64     
+ Partials        3        2       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@tdeekens tdeekens force-pushed the td/deprecate-clis branch 4 times, most recently from 5ebee69 to 67b65f6 Compare March 20, 2025 18:43
@tdeekens tdeekens requested a review from barbara79 March 20, 2025 18:44
@tdeekens tdeekens marked this pull request as ready for review March 20, 2025 18:44
@ajimae
Copy link
Member

ajimae commented Mar 21, 2025

Thanks a lot for this PR 🚀

We have this docs page and I can see that we are completely removing the dos from this repository.

My question is what will become of the docs website, are we going to completely unpublish it as well or keep it?

@industrian
Copy link
Contributor

industrian commented Mar 21, 2025

Hi, when do you intend to merge this PR and would it impact our docs in any way? Please provide us with information regarding the pages from https://commercetools.github.io/nodejs/ which are being removed as we may need to make adjustments.

The CLI tools have been deprecated starting March 31st 2025.

I would recommend creating a release note for this on the docs repo. Have users of these tools been informed of this deprecation in advance?

@tdeekens
Copy link
Contributor Author

I would recommend creating a release note for this on the docs repo. Have users of these tools been informed of this deprecation in advance?

Hi @industrian we decided to keep the docs pages available and fix them for the packages which continue to exist. I will doublecheck if anything removed is linked to.

@tdeekens tdeekens force-pushed the td/deprecate-clis branch from 67b65f6 to afface0 Compare March 21, 2025 13:48
@tdeekens tdeekens self-assigned this Mar 21, 2025
@tdeekens
Copy link
Contributor Author

I double checked @industrian: any public facing documentation only links to the personal data ereasure which will remain accessible.

Furthermore the release notes of Impex also pointed out that

Screenshot 2025-03-21 at 15 55 14@2x

So this isn't a surprise I think.

docs/SUMMARY.md Outdated
@@ -0,0 +1,29 @@
# Table of Contents
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this file was removed in default branch as it's the nav is built automatically

Copy link
Contributor

@jenschude jenschude left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small nitpick

Copy link
Contributor

@barbara79 barbara79 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
Thank you!

@tdeekens tdeekens merged commit ff3b23c into master Mar 24, 2025
10 checks passed
@tdeekens tdeekens deleted the td/deprecate-clis branch March 24, 2025 08:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants