-
Notifications
You must be signed in to change notification settings - Fork 536
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
Deprecate MarkdownEditor
, MarkdownViewer
, InlineAutocomplete
, and related code
#4027
Conversation
🦋 Changeset detectedLatest commit: 42016cf The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
size-limit report 📦
|
@iansan5653 just wanted to ask, is usage over in dotcom already migrated over to use the internal version of this component or would it be helpful to add linting to help folks move over to the new package? |
…react into deprecate-markdowneditor
Not yet. I haven't actually copied the code over to dotcom, but when I do so I will add linting accordingly. I have already added rules to lint specifically against importing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Assuming we don't want to move these to the deprecated
package yet, this looks correct to me.
Not sure what we would do here, since they are already in the |
Per #3604, we will migrate the following draft/experimental APIs from
primer/react
to the internal GitHub codebase. Since drafts are not semvered we technically don't have to deprecate them, but I think it's still probably a good idea to follow a deprecation process rather than having them just disappear. So this PR deprecates the components, and then in v37 we can ultimately delete the code. This would be an aggressive timeline for other APIs, but again these are all drafts:MarkdownEditor
MardownViewer
InlineAutocomplete
hooks/useCombobox
hooks/useDynamicTextareaHeight
hooks/useIgnoreKeyboardActionsWhileComposing
hooks/useSafeAsyncCallback
hooks/useSyntheticChange
hooks/useUnifiedFileSelect
,useClickFileSelect
,useDropFileSelect
,usePasteFileSelect
While some internal APIs will be migrated as well, I've focused on public APIs here.
Side note: I also moved
InlineAutocomplete
intodrafts
where it belongs. Not sure how it escaped 🤷.Changelog
New
Changed
MarkdownEditor
,MardownViewer
,InlineAutocomplete
, and related hooksRemoved
Rollout strategy
Testing & Reviewing
Merge checklist
[ ] Added/updated tests[ ] Tested in Chrome[ ] Tested in Firefox[ ] Tested in Safari[ ] Tested in Edge[ ] Integration tests pass at github/github (Learn more about how to run integration tests)Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.