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(serialize): Bump csstype #1956

Merged
merged 10 commits into from
Aug 9, 2020
Merged

Conversation

eps1lon
Copy link
Contributor

@eps1lon eps1lon commented Aug 3, 2020

What:

Bump csstype in @emotion/serialize.

Why:

Align type ecosystem to avoid potential type conflicts. All @types/* packages already switched DefinitelyTyped/DefinitelyTyped#46435

How:

  • make sure test:typescript is ran in CI
  • fix test:typescript first
  • bump csstype and see if test:typescript still passes (it does)

Checklist:

  • [ ] Documentation
  • Tests
  • Code complete
  • Changeset

@changeset-bot
Copy link

changeset-bot bot commented Aug 3, 2020

🦋 Changeset is good to go

Latest commit: e9c87f0

We got this.

This PR includes changesets to release 7 packages
Name Type
@emotion/serialize Minor
@emotion/babel-plugin Patch
@emotion/css Patch
@emotion/react Patch
@emotion/styled Patch
@emotion/server Patch
@emotion/jest 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

.circleci/config.yml Outdated Show resolved Hide resolved
@@ -16,41 +16,41 @@ const testObjectInterpolation1: ObjectInterpolation<undefined> = {
}

// $ExpectType SerializedStyles
serializeStyles({}, [])
serializeStyles([], {})
Copy link
Member

Choose a reason for hiding this comment

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

any particular reason why those tests had to be updated?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

They did not pass on master

Copy link
Contributor Author

Choose a reason for hiding this comment

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

More specifically: Most of the packages do not pass their own test:typescript on master and types aren't tested in CI. I don't know about the state of next but it's not apparent from CONTRIBUTING.md on which branch development should happen.

@Andarist
Copy link
Member

Andarist commented Aug 3, 2020

Do you know what kind of breaking changes were included in v3? It's not super apparent from this: https://www.npmjs.com/package/csstype#version-30

@eps1lon
Copy link
Contributor Author

eps1lon commented Aug 3, 2020

Do you know what kind of breaking changes were included in v3? It's not super apparent from this: npmjs.com/package/csstype#version-30

This seems sufficient to me. With types breaking changes reveal themselves. Anything that's not necessarily findable with a structural type system is listed e.g. string & {} for autocomplete.

@Andarist
Copy link
Member

Andarist commented Aug 3, 2020

This seems sufficient to me. With types breaking changes reveal themselves.

Our consumers might often not be aware that they are using an external library like csstype - and when we publish a new version of our package it would be ideal to document breaking changes from our PoV.

Anything that's not necessarily findable with a structural type system is listed e.g. string & {} for autocomplete.

Isn't it a new feature, sort-of, rather than a breaking change? As is - it seems to allow more than before?

@eps1lon
Copy link
Contributor Author

eps1lon commented Aug 3, 2020

Isn't it a new feature, sort-of, rather than a breaking change? As is - it seems to allow more than before?

Can't fault by making a bigger bump than necessary.

Our consumers might often not be aware that they are using an external library like csstype - and when we publish a new version of our package it would be ideal to document breaking changes from our PoV.

Quickly scanned the project and could not see any exposure of these namespaces. I could not find any breakage in dependent packages when csstype was bumped in the @types packages (DefinitelyTyped/DefinitelyTyped#46435). Only direct consumers had to change code. Seems safe to me.

@Andarist
Copy link
Member

Andarist commented Aug 3, 2020

Ok - thanks for checking this. I will handle this soon-ish - need to recheck versioning between master&next and other organizational stuff in the repo. I assume you are interested in including this change in the current latest version (v10) and waiting for it to be released in the upcoming major version (v11) is not good enough, right?

@eps1lon
Copy link
Contributor Author

eps1lon commented Aug 3, 2020

I assume you are interested in including this change in the current latest version (v10) and waiting for it to be released in the upcoming major version (v11) is not good enough, right?

It's not blocking me in any way. Whatever timeline works best for you should be preferred.

@Andarist Andarist changed the base branch from master to next August 9, 2020 14:31
# Conflicts:
#	packages/serialize/package.json
#	packages/serialize/types/tests.ts
#	packages/serialize/types/tslint.json
#	yarn.lock
@codesandbox-ci
Copy link

codesandbox-ci bot commented Aug 9, 2020

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit e9c87f0:

Sandbox Source
Emotion Configuration

@Andarist Andarist merged commit 5d692a6 into emotion-js:next Aug 9, 2020
@github-actions github-actions bot mentioned this pull request Aug 9, 2020
louisgv pushed a commit to louisgv/emotion that referenced this pull request Sep 6, 2020
* Remove grayscale filter from the docs (emotion-js#1929)

* Add emotion-native-extended to the ecosystem list of packages (emotion-js#1849)

* Make links more accessible in the docs (emotion-js#1930)

* run test:typescript for emotion/serialize in CI

* fix emotion/serialize type tests

* Bump csstype to 3.0.2

* Add changeset

* Update .circleci/config.yml

* Tweak changeset

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
Co-authored-by: Wendell Misiedjan <wmisiedj@student.codam.nl>
@github-actions github-actions bot mentioned this pull request Nov 10, 2020
@eps1lon eps1lon deleted the feat/bump-csstype branch July 13, 2021 08:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants