Skip to content

Commit 69238b8

Browse files
authored
[core] Prepare stable release from the v6.x branch (#45133)
1 parent 045b84d commit 69238b8

File tree

46 files changed

+118
-98
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+118
-98
lines changed

.circleci/config.yml

+7-4
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ jobs:
129129
name: '`pnpm dedupe` was run?'
130130
command: |
131131
# #default-branch-switch
132-
if [[ $(git diff --name-status master | grep -E 'pnpm-workspace\.yaml|pnpm-lock.yaml|package\.json') == "" ]];
132+
if [[ $(git diff --name-status v6.x | grep -E 'pnpm-workspace\.yaml|pnpm-lock.yaml|package\.json') == "" ]];
133133
then
134134
echo "No changes to dependencies detected. Skipping..."
135135
else
@@ -921,9 +921,10 @@ workflows:
921921
filters:
922922
branches:
923923
only:
924+
# #target-branch-reference
924925
- master
925-
- next
926926
- v5.x
927+
- v6.x
927928
jobs:
928929
- test_unit:
929930
<<: *default-context
@@ -971,8 +972,9 @@ workflows:
971972
filters:
972973
branches:
973974
only:
975+
# #target-branch-reference
974976
- master
975-
- next
977+
- v6.x
976978
jobs:
977979
- test_unit:
978980
<<: *default-context
@@ -998,8 +1000,9 @@ workflows:
9981000
filters:
9991001
branches:
10001002
only:
1003+
# #target-branch-reference
10011004
- master
1002-
- next
1005+
- v6.x
10031006
jobs:
10041007
- test_types_next:
10051008
<<: *default-context

.github/workflows/maintenance.yml

+4-2
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,17 @@ on:
44
# So that PRs touching the same files as the push are updated
55
push:
66
branches:
7+
# #target-branch-reference
78
- master
8-
- next
9+
- v6.x
910
# So that the `dirtyLabel` is removed if conflicts are resolved
1011
# Could put too much strain on rate limit
1112
# If we hit the rate limit too often remove this event
1213
pull_request_target:
1314
branches:
15+
# #target-branch-reference
1416
- master
15-
- next
17+
- v6.x
1618
types: [synchronize]
1719

1820
permissions: {}

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,9 @@ For how-to questions that don't involve making changes to the code base, please
107107

108108
## Examples
109109

110-
Our documentation features [a collection of example projects](https://github.com/mui/material-ui/tree/master/examples).
110+
<!-- #repo-reference -->
111+
112+
Our documentation features [a collection of example projects](https://github.com/mui/material-ui/tree/v6.x/examples).
111113

112114
## Premium templates
113115

docs/data/material/customization/dark-mode/dark-mode.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,9 @@ Use the `theme.applyStyles()` utility to apply styles for a specific mode.
175175

176176
We recommend using this function over checking `theme.palette.mode` to switch between styles as it has more benefits:
177177

178-
- It can be used with [Pigment CSS](https://github.com/mui/material-ui/tree/master/packages/pigment-css-react), our in-house zero-runtime CSS-in-JS solution.
178+
<!-- #repo-reference -->
179+
180+
- It can be used with [Pigment CSS](https://github.com/mui/material-ui/tree/v6.x/packages/pigment-css-react), our in-house zero-runtime CSS-in-JS solution.
179181
- It is generally more readable and maintainable.
180182
- It is slightly more performant as it doesn't require to do style recalculation but the bundle size of SSR generated styles is larger.
181183

docs/data/material/customization/palette/palette.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,9 @@ const theme = createTheme({
149149

150150
{{"demo": "ManuallyProvideCustomColor.js", "defaultCodeOpen": false}}
151151

152-
If you need to manipulate colors, `@mui/material/styles` provides [a set of utilities](https://github.com/mui/material-ui/blob/master/packages/mui-material/src/styles/index.d.ts#L52-L67) to help with this.
152+
<!-- #repo-reference -->
153+
154+
If you need to manipulate colors, `@mui/material/styles` provides [a set of utilities](https://github.com/mui/material-ui/blob/v6.x/packages/mui-material/src/styles/index.d.ts#L52-L67) to help with this.
153155
The following example uses the `alpha()` and `getContrastRatio()` utilities to define tokens using opacity:
154156

155157
```jsx

docs/data/material/getting-started/example-projects/example-projects.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44

55
## Official integrations
66

7-
The following integration examples are available in the [`/examples`](https://github.com/mui/material-ui/tree/master/examples) folder of the Material UI GitHub repository.
7+
<!-- #repo-reference -->
8+
9+
The following integration examples are available in the [`/examples`](https://github.com/mui/material-ui/tree/v6.x/examples) folder of the Material UI GitHub repository.
810
These examples feature Material UI paired with other popular React libraries and frameworks, so you can skip the initial setup steps and jump straight into building.
911

1012
:::success

docs/data/material/getting-started/installation/installation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ You can start using Material UI right away with minimal front-end infrastructur
158158

159159
<!-- #default-branch-switch -->
160160

161-
Follow [this CDN example](https://github.com/mui/material-ui/tree/master/examples/material-ui-via-cdn) to get started.
161+
Follow [this CDN example](https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-via-cdn) to get started.
162162

163163
:::error
164164
We do _not_ recommend using this approach in production.

docs/data/material/getting-started/supported-platforms/supported-platforms.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You don't need to provide any JavaScript polyfill as it manages unsupported brow
1515

1616
<!-- #default-branch-switch -->
1717

18-
An extensive list can be found in our [.browserlistrc](https://github.com/mui/material-ui/blob/-/.browserslistrc#L12-L27) (check the `stable` entry).
18+
An extensive list can be found in our [.browserlistrc](https://github.com/mui/material-ui/blob/v6.x/.browserslistrc#L12-L27) (check the `stable` entry).
1919

2020
Because Googlebot uses a web rendering service (WRS) to index the page content, it's critical that Material UI supports it.
2121
[WRS regularly updates the rendering engine it uses](https://webmasters.googleblog.com/2019/05/the-new-evergreen-googlebot.html).

docs/data/material/getting-started/templates/blog/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<!-- #default-branch-switch -->
66

7-
1. Copy these folders (`blog` and `shared-theme`) into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/master/examples).
7+
1. Copy these folders (`blog` and `shared-theme`) into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/v6.x/examples).
88
2. Make sure your project has the required dependencies: @mui/material, @mui/icons-material, @emotion/styled, @emotion/react, markdown-to-jsx.
99
3. Import and use the `Blog` component.
1010

docs/data/material/getting-started/templates/checkout/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<!-- #default-branch-switch -->
66

7-
1. Copy these folders (`checkout` and `shared-theme`) into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/master/examples).
7+
1. Copy these folders (`checkout` and `shared-theme`) into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/v6.x/examples).
88
2. Make sure your project has the required dependencies: @mui/material, @emotion/styled, @emotion/react.
99
3. Import and use the `Checkout` component.
1010

docs/data/material/getting-started/templates/dashboard/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<!-- #default-branch-switch -->
66

7-
1. Copy these folders (`dashboard` and `shared-theme`) into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/master/examples).
7+
1. Copy these folders (`dashboard` and `shared-theme`) into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/v6.x/examples).
88
2. Make sure your project has the required dependencies: @mui/material, @mui/icons-material, @emotion/styled, @emotion/react, @mui/x-charts, @mui/x-date-pickers, @mui/x-data-grid, @mui/x-tree-view, dayjs
99
3. Import and use the `Dashboard` component.
1010

docs/data/material/getting-started/templates/marketing-page/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<!-- #default-branch-switch -->
66

7-
1. Copy these folders (`marketing-page` and `shared-theme`) into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/master/examples).
7+
1. Copy these folders (`marketing-page` and `shared-theme`) into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/v6.x/examples).
88
2. Make sure your project has the required dependencies: @mui/material, @mui/icons-material, @emotion/styled, @emotion/react.
99
3. Import and use the `MarketingPage` component.
1010

docs/data/material/getting-started/templates/sign-in-side/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<!-- #default-branch-switch -->
66

7-
1. Copy these folders (`sign-in-side` and `shared-theme`) into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/master/examples).
7+
1. Copy these folders (`sign-in-side` and `shared-theme`) into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/v6.x/examples).
88
2. Make sure your project has the required dependencies: @mui/material, @mui/icons-material, @emotion/styled, @emotion/react.
99
3. Import and use the `SignInSide` component.
1010

docs/data/material/getting-started/templates/sign-in/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<!-- #default-branch-switch -->
66

7-
1. Copy these folders (`sign-in` and `shared-theme`) into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/master/examples).
7+
1. Copy these folders (`sign-in` and `shared-theme`) into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/v6.x/examples).
88
2. Make sure your project has the required dependencies: @mui/material, @mui/icons-material, @emotion/styled, @emotion/react.
99
3. Import and use the `SignIn` component.
1010

docs/data/material/getting-started/templates/sign-up/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<!-- #default-branch-switch -->
66

7-
1. Copy these folders (`sign-up` and `shared-theme`) into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/master/examples).
7+
1. Copy these folders (`sign-up` and `shared-theme`) into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/v6.x/examples).
88
2. Make sure your project has the required dependencies: @mui/material, @mui/icons-material, @emotion/styled, @emotion/react.
99
3. Import and use the `SignUp` component.
1010

docs/data/material/guides/localization/localization.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ The [Data Grid and Data Grid Pro](/x/react-data-grid/) components have their own
9898

9999
<!-- #default-branch-switch -->
100100

101-
You can [find the source](https://github.com/mui/material-ui/blob/master/packages/mui-material/src/locale/index.ts) in the GitHub repository.
101+
You can [find the source](https://github.com/mui/material-ui/blob/v6.x/packages/mui-material/src/locale/index.ts) in the GitHub repository.
102102

103103
To create your own translation, or to customize the English text, copy this file to your project, make any changes needed and import the locale from there.
104104

docs/data/material/guides/typescript/typescript.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<!-- #default-branch-switch -->
88

9-
Material UI requires a minimum version of TypeScript 4.7. Have a look at the [Create React App with TypeScript](https://github.com/mui/material-ui/tree/master/examples/material-ui-cra-ts) example.
9+
Material UI requires a minimum version of TypeScript 4.7. Have a look at the [Create React App with TypeScript](https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-cra-ts) example.
1010

1111
For types to work, it's recommended that you have at least the following options enabled in your `tsconfig.json`:
1212

docs/data/material/integrations/interoperability/interoperability.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -274,8 +274,8 @@ If, however, you would like to use styled-components, you can configure your app
274274

275275
<!-- #default-branch-switch -->
276276

277-
- [Create React App with styled-components](https://github.com/mui/material-ui/tree/master/examples/material-ui-cra-styled-components)
278-
- [Create React App with styled-components and TypeScript](https://github.com/mui/material-ui/tree/master/examples/material-ui-cra-styled-components-ts)
277+
- [Create React App with styled-components](https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-cra-styled-components)
278+
- [Create React App with styled-components and TypeScript](https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-cra-styled-components-ts)
279279

280280
Following this approach reduces the bundle size, and removes the need to configure the CSS injection order.
281281

@@ -580,7 +580,9 @@ It works exactly like styled components. You can [use the same guide](/material-
580580

581581
### Setup
582582

583-
If you are used to Tailwind CSS and want to use it together with the Material UI components, you can start by cloning the [Tailwind CSS](https://github.com/mui/material-ui/tree/master/examples/material-ui-cra-tailwind-ts) example project.
583+
<!-- #repo-reference -->
584+
585+
If you are used to Tailwind CSS and want to use it together with the Material UI components, you can start by cloning the [Tailwind CSS](https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-cra-tailwind-ts) example project.
584586
If you use a different framework, or already have set up your project, follow these steps:
585587

586588
1. Add Tailwind CSS to your project, following the instructions in https://tailwindcss.com/docs/installation.

docs/data/material/integrations/styled-components/styled-components.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ We provide boilerplate examples of Create React App with Material UI and styled
102102

103103
<!-- #default-branch-switch -->
104104

105-
- [Material UI + CRA + styled-components (JavaScript)](https://github.com/mui/material-ui/tree/master/examples/material-ui-cra-styled-components)
106-
- [Material UI + CRA + styled-components (TypeScript)](https://github.com/mui/material-ui/tree/master/examples/material-ui-cra-styled-components-ts)
105+
- [Material UI + CRA + styled-components (JavaScript)](https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-cra-styled-components)
106+
- [Material UI + CRA + styled-components (TypeScript)](https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-cra-styled-components-ts)
107107

108108
:::warning
109109
`@emotion/react`, `@emotion/styled`, and `styled-components` are optional peer dependencies of `@mui/material`, so you need to install them yourself.

docs/data/system/experimental-api/css-theme-variables/css-theme-variables.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,9 @@ Now, the Button's `backgroundColor`, `borderColor` and text `color` values will
189189
For framework- or language-specific setup instructions, see [CSS theme variables—Usage—Server-side rendering](/material-ui/customization/css-theme-variables/usage/).
190190
For framework or language specific setup, see [this](/material-ui/customization/css-theme-variables/usage/)
191191

192-
See the complete usage of `createCssVarsProvider` in [Material UI](https://github.com/mui/material-ui/blob/master/packages/mui-material/src/styles/ThemeProviderWithVars.tsx) and [Joy UI](https://github.com/mui/material-ui/blob/master/packages/mui-joy/src/styles/CssVarsProvider.tsx).
192+
<!-- #repo-reference -->
193+
194+
See the complete usage of `createCssVarsProvider` in [Material UI](https://github.com/mui/material-ui/blob/v6.x/packages/mui-material/src/styles/ThemeProviderWithVars.tsx) and [Joy UI](https://github.com/mui/material-ui/blob/v6.x/packages/mui-joy/src/styles/CssVarsProvider.tsx).
193195

194196
## API
195197

docs/data/system/getting-started/usage/usage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ Runtime performance takes a hit.
158158

159159
<!-- #default-branch-switch -->
160160

161-
Visit the [benchmark folder](https://github.com/mui/material-ui/tree/master/benchmark/browser) for a reproduction of the metrics above.
161+
Visit the [benchmark folder](https://github.com/mui/material-ui/tree/v6.x/benchmark/browser) for a reproduction of the metrics above.
162162

163163
We believe that for most use cases it's fast enough, but there are simple workarounds when performance becomes critical.
164164
For instance, when rendering a list with many items, you can use a CSS child selector to have a single "style injection" point (using d. for the wrapper and a. for each item).

docs/next.config.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ export default withDocsInfra({
189189
// docs-infra
190190
LIB_VERSION: pkg.version,
191191
SOURCE_CODE_REPO: 'https://github.com/mui/material-ui',
192-
SOURCE_GITHUB_BRANCH: 'master', // #default-branch-switch
192+
SOURCE_GITHUB_BRANCH: 'v6.x', // #default-branch-switch
193193
GITHUB_TEMPLATE_DOCS_FEEDBACK: '4.docs-feedback.yml',
194194
BUILD_ONLY_ENGLISH_LOCALE: String(buildOnlyEnglishLocale),
195195
// MUI Core related

docs/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"build:clean": "rimraf .next && pnpm build",
1010
"build-sw": "node ./scripts/buildServiceWorker.js",
1111
"dev": "next dev",
12-
"deploy": "git push -f material-ui-docs master:latest",
12+
"deploy": "git push -f material-ui-docs v6.x:latest",
1313
"icons": "rimraf --glob public/static/icons/* && node ./scripts/buildIcons.js",
1414
"start": "serve ./export",
1515
"create-playground": "cpy --cwd=scripts playground.template.tsx ../../pages/playground --rename=index.tsx",

docs/src/modules/components/MaterialUIExampleCollection.js

+16-16
Original file line numberDiff line numberDiff line change
@@ -14,78 +14,78 @@ const examples = [
1414
name: 'Next.js App Router',
1515
label: 'View JavaScript',
1616
tsLabel: 'View TypeScript',
17-
link: 'https://github.com/mui/material-ui/tree/master/examples/material-ui-nextjs',
18-
tsLink: 'https://github.com/mui/material-ui/tree/master/examples/material-ui-nextjs-ts',
17+
link: 'https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-nextjs',
18+
tsLink: 'https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-nextjs-ts',
1919
src: '/static/images/examples/next.svg',
2020
},
2121
{
2222
name: 'Next.js Pages Router',
2323
label: 'View JavaScript',
2424
tsLabel: 'View TypeScript',
25-
link: 'https://github.com/mui/material-ui/tree/master/examples/material-ui-nextjs-pages-router',
25+
link: 'https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-nextjs-pages-router',
2626
tsLink:
27-
'https://github.com/mui/material-ui/tree/master/examples/material-ui-nextjs-pages-router-ts',
27+
'https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-nextjs-pages-router-ts',
2828
src: '/static/images/examples/next.svg',
2929
},
3030
{
3131
name: 'Vite.js',
3232
label: 'View JavaScript',
3333
tsLabel: 'View TypeScript',
34-
link: 'https://github.com/mui/material-ui/tree/master/examples/material-ui-vite',
35-
tsLink: 'https://github.com/mui/material-ui/tree/master/examples/material-ui-vite-ts',
34+
link: 'https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-vite',
35+
tsLink: 'https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-vite-ts',
3636
src: '/static/images/examples/vite.svg',
3737
},
3838
{
3939
name: 'Remix',
4040
label: 'View TypeScript',
41-
link: 'https://github.com/mui/material-ui/tree/master/examples/material-ui-remix-ts',
41+
link: 'https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-remix-ts',
4242
src: '/static/images/examples/remix.svg',
4343
},
4444
{
4545
name: 'Create React App',
4646
label: 'View JavaScript',
4747
tsLabel: 'View TypeScript',
48-
link: 'https://github.com/mui/material-ui/tree/master/examples/material-ui-cra',
49-
tsLink: 'https://github.com/mui/material-ui/tree/master/examples/material-ui-cra-ts',
48+
link: 'https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-cra',
49+
tsLink: 'https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-cra-ts',
5050
src: '/static/images/examples/cra.svg',
5151
},
5252
{
5353
name: 'Tailwind CSS + Create React App',
5454
label: 'View TypeScript',
55-
link: 'https://github.com/mui/material-ui/tree/master/examples/material-ui-cra-tailwind-ts',
55+
link: 'https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-cra-tailwind-ts',
5656
src: '/static/images/examples/tailwindcss.svg',
5757
},
5858
{
5959
name: 'styled-components',
6060
label: 'View JavaScript',
6161
tsLabel: 'View TypeScript',
62-
link: 'https://github.com/mui/material-ui/tree/master/examples/material-ui-cra-styled-components',
62+
link: 'https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-cra-styled-components',
6363
tsLink:
64-
'https://github.com/mui/material-ui/tree/master/examples/material-ui-cra-styled-components-ts',
64+
'https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-cra-styled-components-ts',
6565
src: '/static/images/examples/styled.png',
6666
},
6767
{
6868
name: 'Preact',
6969
label: 'View JavaScript',
70-
link: 'https://github.com/mui/material-ui/tree/master/examples/material-ui-preact',
70+
link: 'https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-preact',
7171
src: '/static/images/examples/preact.svg',
7272
},
7373
{
7474
name: 'CDN',
7575
label: 'View JavaScript',
76-
link: 'https://github.com/mui/material-ui/tree/master/examples/material-ui-via-cdn',
76+
link: 'https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-via-cdn',
7777
src: <CloudRoundedIcon />,
7878
},
7979
{
8080
name: 'Express.js (server-rendered)',
8181
label: 'View JavaScript',
82-
link: 'https://github.com/mui/material-ui/tree/master/examples/material-ui-express-ssr',
82+
link: 'https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-express-ssr',
8383
src: '/static/images/examples/express.png',
8484
},
8585
{
8686
name: 'Gatsby',
8787
label: 'View JavaScript',
88-
link: 'https://github.com/mui/material-ui/tree/master/examples/material-ui-gatsby',
88+
link: 'https://github.com/mui/material-ui/tree/v6.x/examples/material-ui-gatsby',
8989
src: '/static/images/examples/gatsby.svg',
9090
},
9191
];

0 commit comments

Comments
 (0)