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

Rename unreleased to drafts to avoid confusion #1609

Merged
merged 3 commits into from
Nov 16, 2021

Conversation

siddharthkp
Copy link
Member

@siddharthkp siddharthkp commented Nov 15, 2021

Rename @primer/components/unreleased to @primer/components/drafts

--

Picked a name that doesn't conflict with component maturity status - experimental/alpha/beta/stable
& doesn't conflict with package publishing language - published/released/next/apha/beta

Thanks to @pksjce for the suggestion!

--

  • In the docs, because we have multiple ActionLists now, we import it ActionList2 from a different scope:
const {ActionList} = drafts

render(
  <ActionList>
    ...
  </ActionList>
)

This causes confusion in where does drafts come from?

The long term fix would be to modify the scope conditionally by tagging the code block with "drafts": ```javascript live drafts.

For now, the bandaid is the add a comment to ignore the internal silliness and import from the path

// import {ActionList} from '@primer/components/drafts'
const {ActionList} = drafts // ignore docs silliness, import like that ↑

@siddharthkp siddharthkp requested review from a team and rezrah November 15, 2021 17:05
@changeset-bot
Copy link

changeset-bot bot commented Nov 15, 2021

🦋 Changeset detected

Latest commit: 5e5f550

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@primer/components Patch

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

@siddharthkp siddharthkp changed the title rename unreleased to drafts Rename unreleased to drafts to avoid confusion Nov 15, 2021
@siddharthkp siddharthkp self-assigned this Nov 15, 2021
@siddharthkp siddharthkp added docs Documentation react labels Nov 15, 2021
@siddharthkp
Copy link
Member Author

@pksjce @jclem FYI!

@github-actions
Copy link
Contributor

github-actions bot commented Nov 15, 2021

size-limit report 📦

Path Size
dist/browser.esm.js 54.96 KB (0%)
dist/browser.umd.js 55.35 KB (0%)

Copy link
Contributor

@colebemis colebemis left a comment

Choose a reason for hiding this comment

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

:shipit:

@siddharthkp siddharthkp merged commit 5eb7ade into main Nov 16, 2021
@siddharthkp siddharthkp deleted the siddharth/rename-unreleased-to-drafts branch November 16, 2021 12:04
This was referenced Nov 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation react
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants