Skip to content

Commit 58d9d9b

Browse files
DiegoAndaiDiegoAndai
authored
[core] Update branch switch tags (#45198)
1 parent 70e8ed0 commit 58d9d9b

File tree

77 files changed

+223
-178
lines changed

Some content is hidden

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

77 files changed

+223
-178
lines changed

‎.circleci/config.yml

+7-4
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ jobs:
133133
- run:
134134
name: '`pnpm dedupe` was run?'
135135
command: |
136-
# #default-branch-switch
136+
# #target-branch-reference
137137
if [[ $(git diff --name-status master | grep -E 'pnpm-workspace\.yaml|pnpm-lock.yaml|package\.json') == "" ]];
138138
then
139139
echo "No changes to dependencies detected. Skipping..."
@@ -926,9 +926,10 @@ workflows:
926926
filters:
927927
branches:
928928
only:
929+
# #target-branch-reference
929930
- master
930-
- next
931931
- v5.x
932+
- v6.x
932933
jobs:
933934
- test_unit:
934935
<<: *default-context
@@ -976,8 +977,9 @@ workflows:
976977
filters:
977978
branches:
978979
only:
980+
# #target-branch-reference
979981
- master
980-
- next
982+
- v6.x
981983
jobs:
982984
- test_unit:
983985
<<: *default-context
@@ -1003,8 +1005,9 @@ workflows:
10031005
filters:
10041006
branches:
10051007
only:
1008+
# #target-branch-reference
10061009
- master
1007-
- next
1010+
- v6.x
10081011
jobs:
10091012
- test_types_next:
10101013
<<: *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: {}

‎CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ cd material-ui
7070
git remote add upstream https://github.com/mui/material-ui.git
7171
```
7272

73-
<!-- #default-branch-switch -->
73+
<!-- #target-branch-reference -->
7474

7575
3. Synchronize your local `master` branch with the upstream one:
7676

@@ -144,7 +144,7 @@ If any of these checks fail, refer to [Checks and how to fix them](#checks-and-h
144144

145145
Make sure the following is true:
146146

147-
<!-- #default-branch-switch -->
147+
<!-- #target-branch-reference -->
148148

149149
- The branch is targeted at `master` for ongoing development. All tests are passing. Code that lands in `master` must be compatible with the latest stable release. It may contain additional features but no breaking changes. We should be able to release a new minor version from the tip of `master` at any time.
150150
- If a feature is being added:

‎README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- #default-branch-switch -->
1+
<!-- #host-reference -->
22
<!-- markdownlint-disable-next-line -->
33
<p align="center">
44
<a href="https://next.mui.com/core/" rel="noopener" target="_blank"><img width="150" height="133" src="https://mui.com/static/logo.svg" alt="Material UI logo"></a>
@@ -108,6 +108,8 @@ For how-to questions that don't involve making changes to the code base, please
108108

109109
## Examples
110110

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

113115
## Premium templates

‎docs/data/material/components/about-the-lab/about-the-lab.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ For a component to be ready to move to the core, the following criteria are cons
1919

2020
To install and save in your `package.json` dependencies, run one of the following commands:
2121

22-
<!-- #default-branch-switch -->
22+
<!-- #npm-tag-reference -->
2323

2424
<codeblock storageKey="package-manager">
2525

‎docs/data/material/components/icons/icons.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ You can [search the full list of these icons](/material-ui/material-icons/).
2626

2727
Run one of the following commands to install it and save it to your `package.json` dependencies:
2828

29-
<!-- #default-branch-switch -->
29+
<!-- #npm-tag-reference -->
3030

3131
<codeblock storageKey="package-manager">
3232
```bash npm

‎docs/data/material/components/material-icons/material-icons.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ includes the 2,100+ official [Material Icons](https://fonts.google.com/icons?ico
1818
It depends on `@mui/material`, which requires Emotion packages.
1919
Use one of the following commands to install it:
2020

21-
<!-- #default-branch-switch -->
21+
<!-- #npm-tag-reference -->
2222

2323
<codeblock storageKey="package-manager">
2424

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

+2
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,8 @@ 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+
<!-- #repo-reference -->
179+
178180
- 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.
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.

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

+2
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,8 @@ const theme = createTheme({
149149

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

152+
<!-- #repo-reference -->
153+
152154
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.
153155
The following example uses the `alpha()` and `getContrastRatio()` utilities to define tokens using opacity:
154156

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

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
## Official integrations
66

7+
<!-- #repo-reference -->
8+
79
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.
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

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

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

77
Run one of the following commands to add Material UI to your project:
88

9-
<!-- #default-branch-switch -->
9+
<!-- #npm-tag-reference -->
1010

1111
<codeblock storageKey="package-manager">
1212

@@ -156,7 +156,7 @@ For instance, via Google Web Fonts:
156156

157157
You can start using Material UI right away with minimal front-end infrastructure by installing it via CDN, which is a great option for rapid prototyping.
158158

159-
<!-- #default-branch-switch -->
159+
<!-- #repo-reference -->
160160

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

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ You don't need to provide any JavaScript polyfill as it manages unsupported brow
1313
| :----- | :------ | :----- | :------------- | :----------- |
1414
| >= 121 | >= 115 | >= 109 | >= 15.4 | >= 15.4 |
1515

16-
<!-- #default-branch-switch -->
16+
<!-- #repo-reference -->
1717

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

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
## Usage
44

5-
<!-- #default-branch-switch -->
5+
<!-- #repo-reference -->
66

77
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).
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

1111
## Demo
1212

13-
<!-- #default-branch-switch -->
13+
<!-- #host-reference -->
1414

1515
View the demo at https://next.mui.com/material-ui/getting-started/templates/blog/.

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
## Usage
44

5-
<!-- #default-branch-switch -->
5+
<!-- #repo-reference -->
66

77
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).
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

1111
## Demo
1212

13-
<!-- #default-branch-switch -->
13+
<!-- #host-reference -->
1414

1515
View the demo at https://next.mui.com/material-ui/getting-started/templates/checkout/.

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
## Usage
44

5-
<!-- #default-branch-switch -->
5+
<!-- #repo-reference -->
66

77
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).
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

1111
## Demo
1212

13-
<!-- #default-branch-switch -->
13+
<!-- #host-reference -->
1414

1515
View the demo at https://next.mui.com/material-ui/getting-started/templates/dashboard/.

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
## Usage
44

5-
<!-- #default-branch-switch -->
5+
<!-- #repo-reference -->
66

77
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).
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

1111
## Demo
1212

13-
<!-- #default-branch-switch -->
13+
<!-- #host-reference -->
1414

1515
View the demo at https://next.mui.com/material-ui/getting-started/templates/marketing-page/.

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
## Usage
44

5-
<!-- #default-branch-switch -->
5+
<!-- #repo-reference -->
66

77
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).
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

1111
## Demo
1212

13-
<!-- #default-branch-switch -->
13+
<!-- #host-reference -->
1414

1515
View the demo at https://next.mui.com/material-ui/getting-started/templates/sign-in-side/.

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
## Usage
44

5-
<!-- #default-branch-switch -->
5+
<!-- #repo-reference -->
66

77
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).
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

1111
## Demo
1212

13-
<!-- #default-branch-switch -->
13+
<!-- #host-reference -->
1414

1515
View the demo at https://next.mui.com/material-ui/getting-started/templates/sign-in/.

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
## Usage
44

5-
<!-- #default-branch-switch -->
5+
<!-- #repo-reference -->
66

77
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).
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

1111
## Demo
1212

13-
<!-- #default-branch-switch -->
13+
<!-- #host-reference -->
1414

1515
View the demo at https://next.mui.com/material-ui/getting-started/templates/sign-up/.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ The [Data Grid and Data Grid Pro](/x/react-data-grid/) components have their own
9696
| Urdu (Pakistan) | ur-PK | `urPK` |
9797
| Vietnamese | vi-VN | `viVN` |
9898

99-
<!-- #default-branch-switch -->
99+
<!-- #repo-reference -->
100100

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

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

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

55
## Minimum configuration
66

7-
<!-- #default-branch-switch -->
7+
<!-- #repo-reference -->
88

99
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.
1010

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

+3-1
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ export default function GlobalCssSliderDeep() {
272272
By default, Material UI components come with Emotion as their style engine.
273273
If, however, you would like to use styled-components, you can configure your app by following the [styled-components guide](/material-ui/integrations/styled-components/) or starting with one of the example projects:
274274

275-
<!-- #default-branch-switch -->
275+
<!-- #repo-reference -->
276276

277277
- [Create React App with styled-components](https://github.com/mui/material-ui/tree/master/examples/material-ui-cra-styled-components)
278278
- [Create React App with styled-components and TypeScript](https://github.com/mui/material-ui/tree/master/examples/material-ui-cra-styled-components-ts)
@@ -580,6 +580,8 @@ It works exactly like styled components. You can [use the same guide](/material-
580580

581581
### Setup
582582

583+
<!-- #repo-reference -->
584+
583585
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.
584586
If you use a different framework, or already have set up your project, follow these steps:
585587

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To use styled-components, you need to configure your bundler to replace it with
3030

3131
If you're using yarn, you can configure it using a package resolution:
3232

33-
<!-- #default-branch-switch -->
33+
<!-- #npm-tag-reference -->
3434

3535
```diff title="package.json"
3636
{
@@ -100,7 +100,7 @@ For TypeScript, you must also update the `tsconfig.json` as shown here:
100100

101101
We provide boilerplate examples of Create React App with Material UI and styled-components in both JavaScript and TypeScript:
102102

103-
<!-- #default-branch-switch -->
103+
<!-- #repo-reference -->
104104

105105
- [Material UI + CRA + styled-components (JavaScript)](https://github.com/mui/material-ui/tree/master/examples/material-ui-cra-styled-components)
106106
- [Material UI + CRA + styled-components (TypeScript)](https://github.com/mui/material-ui/tree/master/examples/material-ui-cra-styled-components-ts)

‎docs/data/styles/basics/basics.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ See the [v5 migration docs](/material-ui/migration/migrating-from-jss/) for deta
1616

1717
To install and save in your `package.json` dependencies, run:
1818

19-
<!-- #default-branch-switch -->
19+
<!-- #npm-tag-reference -->
2020

2121
```bash
2222
npm install @mui/styles@next

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

+2
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,8 @@ 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+
<!-- #repo-reference -->
193+
192194
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).
193195

194196
## API

‎docs/data/system/getting-started/installation/installation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Please note that [react](https://www.npmjs.com/package/react) is a peer dependen
3939
MUI System uses [Emotion](https://emotion.sh/docs/introduction) as its default styling engine.
4040
If you want to use [styled-components](https://styled-components.com/) instead, run one of the following commands:
4141

42-
<!-- #default-branch-switch -->
42+
<!-- #npm-tag-reference -->
4343

4444
<codeblock storageKey="package-manager">
4545

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ Runtime performance takes a hit.
156156
| c. Render 1,000 styled components | `<StyledDiv>` | 181ms |
157157
| d. Render 1,000 Box | `<Box sx={…}>` | 296ms |
158158

159-
<!-- #default-branch-switch -->
159+
<!-- #repo-reference -->
160160

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

‎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: 'master', // #target-branch-reference
193193
GITHUB_TEMPLATE_DOCS_FEEDBACK: '4.docs-feedback.yml',
194194
BUILD_ONLY_ENGLISH_LOCALE: String(buildOnlyEnglishLocale),
195195
// MUI Core related

0 commit comments

Comments
 (0)