chore: add deprecation notice to userprofileimage #6223

davidmenendez · 2024-10-15T18:19:12Z

adds .deprecated to UserProfileImage

netlify · 2024-10-15T18:19:29Z

✅ Deploy Preview for ibm-products-web-components ready!

Name	Link
🔨 Latest commit	`f9ad957`
🔍 Latest deploy log	https://app.netlify.com/sites/ibm-products-web-components/deploys/6761bfb264b0210008c4a0f9
😎 Deploy Preview	https://deploy-preview-6223--ibm-products-web-components.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify · 2024-10-15T18:19:29Z

✅ Deploy Preview for carbon-for-ibm-products ready!

Name	Link
🔨 Latest commit	`f9ad957`
🔍 Latest deploy log	https://app.netlify.com/sites/carbon-for-ibm-products/deploys/6761bfb248f92f000842ea3c
😎 Deploy Preview	https://deploy-preview-6223--carbon-for-ibm-products.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

elycheea · 2024-10-15T18:29:13Z

@davidmenendez Do we want to close this for now or make it a draft? We shouldn’t be deprecating UserProfileImage until we’ve released the UserAvatar as stable.

davidmenendez · 2024-10-15T19:13:10Z

@elycheea yes that's a great point. i'll move this to draft for now 👍

codecov · 2024-11-13T21:05:04Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@9595f65). Learn more about missing BASE report.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6223   +/-   ##
=======================================
  Coverage        ?   80.76%           
=======================================
  Files           ?      395           
  Lines           ?    12885           
  Branches        ?     4266           
=======================================
  Hits            ?    10407           
  Misses          ?     2478           
  Partials        ?        0

Components	Coverage Δ
ibm-products	`∅ <ø> (?)`
ibm-products-web-components	`∅ <ø> (?)`

elycheea · 2024-11-19T22:20:13Z

Keeping the blocked label here until we actually release user avatar (See #6469)

elycheea · 2024-12-04T18:43:42Z

packages/ibm-products/src/components/UserAvatar/UserAvatar.mdx

@anamikaanu96 thoughts on adding some docs on the codemod here? :)

yea we already have an issue for that, we can do codemod doc along this with PR,
"This component is deprecated and will be removed in the next major version. You can migrate this component to 'User avatar' using the below command"
npx @carbon/upgrade migrate ibm-products-update-userprofileimage --write

elycheea · 2024-12-04T18:45:57Z

packages/ibm-products/src/components/UserProfileImage/UserProfileImage.stories.jsx

+            <div>
+              This component is deprecated and will be removed in the next major
+              version. Please migrate to{' '}
+              <a href="/?path=/docs/experimental-components-user-avatar-useravatar--docs">


Suggested change

<a href="/?path=/docs/experimental-components-user-avatar-useravatar--docs">

<a href="/?path=/docs/ibm-products-components-user-avatar-useravatar--docs">

thanks for catching. fixt

elycheea

Caught a few cspell improvements.

@anamikaanu96 If we have an issue to track that, it should be sufficient! No need to roll it into this PR yet — unless you and @davidmenendez would prefer to collab to add it here. Might be better for our definition of done, but can wait if we want to discuss the structure some more.

elycheea · 2024-12-06T18:40:24Z

cspell.json

@@ -201,6 +199,7 @@
    "typeahead",
    "typeof",
    "unauthorizedemptystate",
+    "useravatar",


Suggested change

"useravatar",

Let’s keep the cspell disables for useravatar inline since I think it only applies when we’re putting it in the URL. (I do realize a lot of our other components probably made it into cspell for the same reason, but it does make us a bit more prone to spelling/stylistic errors.)

elycheea · 2024-12-06T18:45:55Z

packages/ibm-products/src/components/UserProfileImage/UserProfileImage.docs-page.js

@@ -11,6 +12,7 @@ import * as stories from './UserProfileImage.stories';

 const DocsPage = () => (
  <StoryDocsPage
+    deprecationNotice="This component is deprecated and will be removed in the next major version. Please migrate to [UserAvatar](?path=/docs/ibm-products-components-user-avatar-useravatar--docs#migration-from-userprofileimage)."


Suggested change

deprecationNotice="This component is deprecated and will be removed in the next major version. Please migrate to [UserAvatar](?path=/docs/ibm-products-components-user-avatar-useravatar--docs#migration-from-userprofileimage)."

// cspell:disable-next-line

deprecationNotice="This component is deprecated and will be removed in the next major version. Please migrate to [UserAvatar](?path=/docs/ibm-products-components-user-avatar-useravatar--docs#migration-from-userprofileimage)."

elycheea · 2024-12-06T18:46:51Z

packages/ibm-products/src/components/UserProfileImage/UserProfileImage.docs-page.js

@@ -1,3 +1,4 @@
+/* cSpell:disable */


Suggested change

/* cSpell:disable */

I would just disable the next line in this case too, but you could alternatively do ...

/* cspell:words useravatar */

elycheea · 2024-12-06T18:47:52Z

packages/ibm-products/src/components/UserProfileImage/UserProfileImage.stories.jsx

+            <div>
+              This component is deprecated and will be removed in the next major
+              version. Please migrate to{' '}
+              <a href="/?path=/docs/ibm-products-components-user-avatar-useravatar--docs">


Suggested change

<a href="/?path=/docs/ibm-products-components-user-avatar-useravatar--docs">

{/* cspell:disable-next-line */}

<a href="/?path=/docs/ibm-products-components-user-avatar-useravatar--docs">

davidmenendez · 2024-12-09T14:01:20Z

@elycheea cspell suggestions have been added. thanks!

elycheea

Since this is a stable component — and high usage at that, the deprecation should probably be more like the Datagrid where it remains in v2, v3 but is removed in v4.

FYI @matthewgallo @RichKummer

chore: add deprecation notice to userprofileimage

2db6112

davidmenendez requested a review from a team as a code owner October 15, 2024 18:19

davidmenendez requested review from elycheea and sangeethababu9223 and removed request for a team October 15, 2024 18:19

elycheea added the status: blocked 🧱 label Oct 15, 2024

chore: add migration docs

76f1ae2

davidmenendez marked this pull request as draft October 15, 2024 19:13

davidmenendez added 2 commits November 13, 2024 14:49

Merge branch 'main' into issue-4140

4ed0092

fix: add deprecation annotation

e138497

davidmenendez added 3 commits November 14, 2024 08:29

fix: add deprecated flag

730fedf

Merge branch 'main' into issue-4140

77aaa76

fix: update to use deprecationNotice prop

3c1c433

davidmenendez added type: deprecation 🕯️ and removed status: blocked 🧱 labels Nov 15, 2024

davidmenendez marked this pull request as ready for review November 15, 2024 16:40

sangeethababu9223 previously approved these changes Nov 19, 2024

View reviewed changes

elycheea added the status: blocked 🧱 label Nov 19, 2024

elycheea removed the status: blocked 🧱 label Dec 4, 2024

Merge branch 'main' into issue-4140

1768523

elycheea reviewed Dec 4, 2024

View reviewed changes

davidmenendez added 2 commits December 4, 2024 13:32

Merge branch 'main' into issue-4140

4ae822b

fix: url doc update

428c590

davidmenendez dismissed sangeethababu9223’s stale review via 428c590 December 4, 2024 19:35

elycheea reviewed Dec 6, 2024

View reviewed changes

elycheea and others added 3 commits December 6, 2024 14:04

Merge branch 'main' into issue-4140

80578cb

Merge branch 'main' into issue-4140

5208539

fix: spellcheck

805df30

elycheea reviewed Dec 13, 2024

View reviewed changes

Merge branch 'main' into issue-4140

f9ad957

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: add deprecation notice to userprofileimage #6223

chore: add deprecation notice to userprofileimage #6223

davidmenendez commented Oct 15, 2024 •

edited

Loading

netlify bot commented Oct 15, 2024 •

edited

Loading

netlify bot commented Oct 15, 2024 •

edited

Loading

elycheea commented Oct 15, 2024

davidmenendez commented Oct 15, 2024

codecov bot commented Nov 13, 2024 •

edited

Loading

elycheea commented Nov 19, 2024

elycheea Dec 4, 2024

anamikaanu96 Dec 5, 2024

elycheea Dec 4, 2024

davidmenendez Dec 4, 2024

elycheea left a comment •

edited

Loading

elycheea Dec 6, 2024

elycheea Dec 6, 2024

elycheea Dec 6, 2024

elycheea Dec 6, 2024

davidmenendez commented Dec 9, 2024

elycheea left a comment

	<a href="/?path=/docs/experimental-components-user-avatar-useravatar--docs">
	<a href="/?path=/docs/ibm-products-components-user-avatar-useravatar--docs">

	deprecationNotice="This component is deprecated and will be removed in the next major version. Please migrate to [UserAvatar](?path=/docs/ibm-products-components-user-avatar-useravatar--docs#migration-from-userprofileimage)."
	// cspell:disable-next-line
	deprecationNotice="This component is deprecated and will be removed in the next major version. Please migrate to [UserAvatar](?path=/docs/ibm-products-components-user-avatar-useravatar--docs#migration-from-userprofileimage)."

	<a href="/?path=/docs/ibm-products-components-user-avatar-useravatar--docs">
	{/* cspell:disable-next-line */}
	<a href="/?path=/docs/ibm-products-components-user-avatar-useravatar--docs">

chore: add deprecation notice to userprofileimage #6223

Are you sure you want to change the base?

chore: add deprecation notice to userprofileimage #6223

Conversation

davidmenendez commented Oct 15, 2024 • edited Loading

netlify bot commented Oct 15, 2024 • edited Loading

✅ Deploy Preview for ibm-products-web-components ready!

netlify bot commented Oct 15, 2024 • edited Loading

✅ Deploy Preview for carbon-for-ibm-products ready!

elycheea commented Oct 15, 2024

davidmenendez commented Oct 15, 2024

codecov bot commented Nov 13, 2024 • edited Loading

Codecov Report

elycheea commented Nov 19, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elycheea left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davidmenendez commented Dec 9, 2024

elycheea left a comment

Choose a reason for hiding this comment

davidmenendez commented Oct 15, 2024 •

edited

Loading

netlify bot commented Oct 15, 2024 •

edited

Loading

netlify bot commented Oct 15, 2024 •

edited

Loading

codecov bot commented Nov 13, 2024 •

edited

Loading

elycheea left a comment •

edited

Loading