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(gatsby-transformer-react-docgen): upgrade to react-docgen 5 #16094

Merged
merged 1 commit into from
Aug 9, 2019

Conversation

jquense
Copy link
Contributor

@jquense jquense commented Jul 25, 2019

BREAKING CHANGE: maybe, the interal api's chagned so folks using custom resolvers will probably be broken, but generally the default user should be unaffected

Description

Related Issues

@jquense jquense requested a review from a team as a code owner July 25, 2019 16:20
@jquense
Copy link
Contributor Author

jquense commented Jul 25, 2019

yup to ya'll whether this counts as a breaking change. Strictly speaking some users will be broken tho

@jquense
Copy link
Contributor Author

jquense commented Aug 6, 2019

ping

BREAKING CHANGE: maybe, the interal api's chagned so folks using custom resolvers will probably be broken, but generally the default user should be unaffected
@sidharthachatterjee
Copy link
Contributor

sidharthachatterjee commented Aug 8, 2019

@jquense Thank you for doing this! The new release looks great (TypeScript support 😍)

I would definitely want to release this as a major version bump (owning to the breaking changes in the resolver signature documented in https://github.com/reactjs/react-docgen/releases/tag/v5.0.0-beta.1 and the fact that we document the custom resolver option in https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-transformer-react-docgen/README.md)

Shall we wait till react-docgen v5 is out of beta?

@sidharthachatterjee sidharthachatterjee added the breaking change If implemented, this proposed work would break functionality for older versions of Gatsby label Aug 8, 2019
@jquense
Copy link
Contributor Author

jquense commented Aug 8, 2019

that is likely to be months at the pace the project tends to move, integers are cheap, so why wait, can always bump again if needed. Up to ya'll but i've published my own version for now so we can get typescript support

@sidharthachatterjee
Copy link
Contributor

@jquense Fair enough! I’ll get this published as a major today

Copy link
Contributor

@sidharthachatterjee sidharthachatterjee left a comment

Choose a reason for hiding this comment

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

Let's get this in! Thank you so much @jquense 🥇

@sidharthachatterjee sidharthachatterjee changed the title feat: upgrade react docgen Aug 9, 2019
@sidharthachatterjee sidharthachatterjee merged commit 16f7670 into master Aug 9, 2019
@sidharthachatterjee sidharthachatterjee deleted the upgrade-react-docgen branch August 9, 2019 11:02
@sidharthachatterjee
Copy link
Contributor

Published in gatsby-transformer-react-docgen@5.0.0

@jquense
Copy link
Contributor Author

jquense commented Aug 9, 2019

🎉 Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change If implemented, this proposed work would break functionality for older versions of Gatsby
2 participants