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

v5.15.0 #5636

Merged
merged 11 commits into from
Jul 29, 2022
Merged

v5.15.0 #5636

merged 11 commits into from
Jul 29, 2022

Conversation

alexfauquette
Copy link
Member

@alexfauquette alexfauquette commented Jul 28, 2022

Prepare the release of the packages

The following steps must be proposed as a pull request.

  • Compare the last tag with the branch upon which you want to release (next for the alpha / beta releases and master for the current stable version).
    To do so, use yarn release:changelog The options are the following:

    yarn release:changelog
       --githubToken   YOUR_GITHUB_TOKEN (needs "public_repo" permission)
       --lastRelease   The release to compare against (default: the last one)
       --release       The branch to release (default: master)

    You can also provide the github token by setting process.env.GITHUB_TOKEN variable.

    In case of a problem, another method to generate the changelog is available at the end of this page.

  • Clean the generated changelog, to match the format of https://github.com/mui/mui-x/releases.

  • Update the root package.json's version

  • Update the versions of the other package.json files and of the dependencies with yarn release:version.

  • Fix manually the package version in x-date-pickers/package.json and x-date-pickers-pro/package.json.

  • Open PR with changes and wait for review and green CI.

  • Merge PR once CI is green, and it has been approved.

Release the packages

  • Checkout the last version of the working branch
  • Make sure you have the latest dependencies installed: yarn.
  • Build the packages: yarn release:build.
  • Release the versions on npm: yarn release:publish (you need your 2FA device).
  • Create a new tag named with the release you just did git tag -a v4.0.0-alpha.30 -m "Version 4.0.0-alpha.30" && git push upstream --tag

Publish the documentation

The documentation must be updated on the docs-vX branch (docs-v4 for v4.X releases, docs-v5 for v5.X releases, ...)

  • Push the working branch on the documentation release branch to deploy the documentation with the latest changes.
git push upstream master:docs-v5 -f

Co-authored-by: Andrew Cherniavskii <andrew.cherniavskii@gmail.com>
@mui-bot
Copy link

mui-bot commented Jul 28, 2022

These are the results for the performance tests:

Test case Unit Min Max Median Mean σ
Filter 100k rows ms 284.6 665.7 516.6 475.28 143.457
Sort 100k rows ms 538.7 1,217.9 1,217.9 966.86 262.134
Select 100k rows ms 228.6 347.3 301.2 291.5 41.031
Deselect 100k rows ms 170.2 350.2 237.3 253.56 60.504

Generated by 🚫 dangerJS against 5283b7b

@alexfauquette
Copy link
Member Author

demoGif

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated
Premium users can now add aggregated data in the grid.
Your user will be able to compute the average, sum, min, and other data with a single click.

![modify aggregation](https://user-images.githubusercontent.com/45398769/181478185-142f87b0-c8de-4585-b381-cf4fdc62d99f.gif)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
![modify aggregation](https://user-images.githubusercontent.com/45398769/181478185-142f87b0-c8de-4585-b381-cf4fdc62d99f.gif)
https://user-images.githubusercontent.com/13808724/181484439-1261f9ab-2c5c-4b70-9afd-0b0e20e053db.mp4

Should we try video instead of gif the way we did in aggregation blogpost?
https://deploy-preview-33595--material-ui.netlify.app/blog/aggregation-functions/

Copy link
Member

Choose a reason for hiding this comment

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

Would they be auto-playable too?

Copy link
Member

@cherniavskii cherniavskii Jul 28, 2022

Choose a reason for hiding this comment

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

No, I don't think so (at least I wasn't able to achieve that). But I think it's still better than the gif

Copy link
Member

Choose a reason for hiding this comment

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

Here's how it would look like in the changelog:
Screenshot 2022-07-28 at 14 34 32

What do you think?

Copy link
Member

@joserodolfofreitas joserodolfofreitas Jul 28, 2022

Choose a reason for hiding this comment

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

True, @cherniavskii. It looks good.
But I'm thinking again, and although the lack of auto-play is not bad, considering the length of the video (10 seconds), the lack of loop might potentially bring a bad experience.

So, +1 to use video if it loops after play.

Copy link
Member

Choose a reason for hiding this comment

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

the lack of loop might potentially bring a bad experience.

Can you elaborate why? Personally, I feel like loop can be a bad user experience - especially in Gifs where it's not always clear whether is a long gif or it's just starting over and over 😀

Copy link
Member

@joserodolfofreitas joserodolfofreitas Jul 28, 2022

Choose a reason for hiding this comment

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

I think that for a user watching the feature in action for the first time (and without much context), 10 seconds will not be enough for them to understand it.
So my bet is that they'd probably need to rewatch the loop a few times.
In this case, if they need to press the play button every time, they will likely be annoyed with the experience or give up on it.

Copy link
Member

Choose a reason for hiding this comment

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

What do you think about using video then?
The quality is better, but no autoplay/loop.

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated
Premium users can now add aggregated data in the grid.
Your user will be able to compute the average, sum, min, and other data with a single click.

![modify aggregation](https://user-images.githubusercontent.com/45398769/181478185-142f87b0-c8de-4585-b381-cf4fdc62d99f.gif)
Copy link
Member

Choose a reason for hiding this comment

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

Would they be auto-playable too?

@cherniavskii
Copy link
Member

cherniavskii commented Jul 28, 2022

I've merged master into this PR to include #5195 in the release

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@DanailH
Copy link
Member

DanailH commented Jul 28, 2022

It would be great if we also tweet this time. This release contains 2 major features.
CC @samuelsycamore

Co-authored-by: Danail Hadjiatanasov <hadjiatanasov@gmail.com>
Co-authored-by: José Rodolfo Freitas <joserodolfo.freitas@gmail.com>
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@samuelsycamore
Copy link
Member

It would be great if we also tweet this time. This release contains 2 major features. CC @samuelsycamore

Sure thing! 🤝

@alexfauquette
Copy link
Member Author

alexfauquette commented Jul 28, 2022

Getting urls for videos

row-pinning.mp4
summary-row.mp4

@alexfauquette
Copy link
Member Author

alexfauquette commented Jul 28, 2022

A resume about discussoin on illustrations:

We have two options:

  • mp4:
    • smaller format
    • it allows seeing and controlling the timeline
    • no looping or auto play (with github)
    • can not customize sizing (always fill width)
  • gif
    • heavier format
    • no timeline
    • loop and autoplay
    • can be resized

After different tries, the more problematic element is the aggregation highlight. To show the column menu you need a lot of height. And so the illustration takes all the place when full size.

Then I used a gif and used a smaller width than usual (600px instead of 800px)

A draft release is available here
https://github.com/mui/mui-x/releases/edit/untagged-802872c2c6343f3187f6

@joserodolfofreitas
Copy link
Member

joserodolfofreitas commented Jul 28, 2022

Thanks for the summary, @alexfauquette!

+1 to experiment with the video.
Revaluating the options, I'd say the benefits of mp4 outweighs the risk of a bad experience with the lack of loop.

@alexfauquette
Copy link
Member Author

@joserodolfofreitas Ok, I will do the release tomorrow morning with the videos

Copy link
Member

@m4theushw m4theushw left a comment

Choose a reason for hiding this comment

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

LGTM

CHANGELOG.md Outdated
@@ -3,6 +3,63 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

## 5.15.0

_Jul 28, 2022_
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
_Jul 28, 2022_
_Jul 29, 2022_

CHANGELOG.md Outdated

Pro users can now pin rows on top or bottom of the grid.

<img src="https://user-images.githubusercontent.com/45398769/181592995-8d35974e-ac54-43f3-bb9f-12522a198814.gif" width="700">
Copy link
Member

Choose a reason for hiding this comment

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

Only the match the width from the other preview.

Suggested change
<img src="https://user-images.githubusercontent.com/45398769/181592995-8d35974e-ac54-43f3-bb9f-12522a198814.gif" width="700">
<img src="https://user-images.githubusercontent.com/45398769/181592995-8d35974e-ac54-43f3-bb9f-12522a198814.gif" width="600">

@alexfauquette alexfauquette merged commit 4816d03 into mui:master Jul 29, 2022
@alexfauquette alexfauquette deleted the release-5.15.0 branch July 29, 2022 07:41
Copy link
Member

@oliviertassinari oliviertassinari left a comment

Choose a reason for hiding this comment

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

Two big features live 🎉

Premium users can now aggregate data in the grid.
Extract information like sum, average, count, and others with a couple of clicks.

https://user-images.githubusercontent.com/45398769/181581503-77cc412e-9d9e-4de1-8bc3-c3bccc54cdaa.mp4
Copy link
Member

@oliviertassinari oliviertassinari Jul 30, 2022

Choose a reason for hiding this comment

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

I have opened https://github.com/orgs/community/discussions/27715 hoping that we will get a clean video support handling by GitHub in the future.

I think that until then, if the file size allows it, it will be better to have .gif. To be clear, I think that it's better to use videos in the blog, I'm considering the changelog here.

As a side note, I have found one way to get high-quality .gif for the first time in my environment. I have documented how it in https://www.notion.so/mui-org/Blog-247ec2bff5fa46e799ef06a693c94917#502bd4e8933641ff8d660ef674150fba, in case it can help for the future. The gif in https://github.com/mui/mui-x/releases/tag/v5.12.0 gets close, but it's still a bit blurry on my end, the image resolution could be x2, it's more like x1.5.

alexfauquette added a commit to alexfauquette/mui-x that referenced this pull request Aug 26, 2022
Co-authored-by: Andrew Cherniavskii <andrew.cherniavskii@gmail.com>
Co-authored-by: Danail Hadjiatanasov <hadjiatanasov@gmail.com>
Co-authored-by: José Rodolfo Freitas <joserodolfo.freitas@gmail.com>
Co-authored-by: Andrew Cherniavskyi <andrew@mui.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release We are shipping :D
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants