Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat!: deprecate Truncate component #3336

Merged
merged 1 commit into from
Dec 11, 2024

Conversation

brian-smith-tcril
Copy link
Contributor

@brian-smith-tcril brian-smith-tcril commented Dec 10, 2024

Description

See #3311 (comment)

Deploy Preview

Include a direct link to your changes in this PR's deploy preview here (e.g., a specific component page).

Merge Checklist

  • If your update includes visual changes, have they been reviewed by a designer? Send them a link to the Netlify deploy preview, if applicable.
  • Does your change adhere to the documented style conventions?
  • Do any prop types have missing descriptions in the Props API tables in the documentation site (check deploy preview)?
  • Were your changes tested using all available themes (see theme switcher in the header of the deploy preview, under the "Settings" icon)?
  • Were your changes tested in the example app?
  • Is there adequate test coverage for your changes?
  • Consider whether this change needs to reviewed/QA'ed for accessibility (a11y). If so, please request an a11y review for the PR in the #wg-paragon Open edX Slack channel.

Post-merge Checklist

  • Verify your changes were released to NPM at the expected version.
  • If you'd like, share your contribution in #show-and-tell.
  • 🎉 🙌 Celebrate! Thanks for your contribution.

Copy link

netlify bot commented Dec 10, 2024

Deploy Preview for paragon-openedx ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit f781370
🔍 Latest deploy log https://app.netlify.com/sites/paragon-openedx/deploys/6759bce75b692f0008a0c223
😎 Deploy Preview https://deploy-preview-3336--paragon-openedx.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link

codecov bot commented Dec 10, 2024

Codecov Report

Attention: Patch coverage is 42.85714% with 4 lines in your changes missing coverage. Please review.

Project coverage is 93.75%. Comparing base (e96baef) to head (f781370).
Report is 192 commits behind head on alpha.

Files with missing lines Patch % Lines
src/Truncate/index.jsx 42.85% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##            alpha    #3336      +/-   ##
==========================================
- Coverage   93.82%   93.75%   -0.07%     
==========================================
  Files         229      230       +1     
  Lines        3836     3862      +26     
  Branches      916      899      -17     
==========================================
+ Hits         3599     3621      +22     
- Misses        230      237       +7     
+ Partials        7        4       -3     

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

@@ -66,4 +66,9 @@ Truncate.defaultProps = {
onTruncate: undefined,
};

function Truncate() {
return null;
Copy link
Member

Choose a reason for hiding this comment

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

[consideration] I wonder if it'd be worth having something like a console.log or similar here to give some output when this no-op component is used, e.g.

function Truncate() {
  useEffect(() => {
    console.log('Please use Truncate.Deprecated until a replacement is created');
  }, []);
  return null;
}

@brian-smith-tcril brian-smith-tcril merged commit d200546 into openedx:alpha Dec 11, 2024
9 of 10 checks passed
@openedx-semantic-release-bot

🎉 This PR is included in version 23.0.0-alpha.7 🎉

The release is available on:

Your semantic-release bot 📦🚀

@openedx-semantic-release-bot

🎉 This PR is included in version 23.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants