Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
version: 2.1
orbs:
code-infra: https://raw.githubusercontent.com/mui/mui-public/3feee347096f50b441cad3087743bd1c5aef8651/.circleci/orbs/code-infra.yml
code-infra: https://raw.githubusercontent.com/mui/mui-public/12844f2b6b11babab17bd3d1f799359ea25d1db7/.circleci/orbs/code-infra.yml
aws-cli: circleci/aws-cli@5.4.1
aws-s3: circleci/aws-s3@4.1.3

Expand Down
25 changes: 25 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ jobs:
os: [macos-latest, windows-latest, ubuntu-latest]
permissions:
contents: read
pull-requests: write
steps:
- run: echo '${{ github.actor }}'
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
Expand Down Expand Up @@ -66,3 +67,27 @@ jobs:
- name: Debug export-detail.json on when pnpm docs:build fails with EMFILE error
if: failure()
run: cat ./docs/.next/export-detail.json || true
- name: Extract Vale version
if: ${{ matrix.os == 'ubuntu-latest' }}
id: vale-version
run: |
VERSION=$(node -p "(require('./package.json').config && require('./package.json').config.valeVersion) || ''")
echo "vale_version=$VERSION" >> $GITHUB_OUTPUT
- name: Cache Vale binary
if: ${{ matrix.os == 'ubuntu-latest' }}
uses: actions/cache@668228422ae6a00e4ad889ee87cd7109ec5666a7 # v5.0.4
with:
path: node_modules/.cache/mui-vale
key: ${{ runner.os }}-mui-vale-${{ steps.vale-version.outputs.vale_version }}
- uses: vale-cli/vale-action@d89dee975228ae261d22c15adcd03578634d429c # v2.1.1
continue-on-error: true # GitHub Action flag needed until https://github.com/errata-ai/vale-action/issues/89 is fixed
if: ${{ matrix.os == 'ubuntu-latest' }}
with:
version: ${{ steps.vale-version.outputs.vale_version }}
# Errors should be more visible
fail_on_error: true
# The other reports don't work, not really https://github.com/reviewdog/reviewdog#reporters
reporter: github-pr-check
# Required, set by GitHub actions automatically:
# https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
token: ${{secrets.GITHUB_TOKEN}}
33 changes: 0 additions & 33 deletions .github/workflows/vale-action.yml

This file was deleted.

7 changes: 1 addition & 6 deletions .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,7 @@
StylesPath = .github/styles
MinAlertLevel = warning

# To update mui-vale package:
# 1. Go to the docs folder
# 2. Update/create YAML files
# 3. Run `pnpm docs:zipRules` to generate the zip files
# 4. You can test locally by replacing the url with the file path of the generated zip
Packages = Google, docs/mui-vale.zip
Packages = Google, ./node_modules/@mui/internal-code-infra/vale

[formats]
mdx = md
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [Versions](https://mui.com/versions/)
# [Versions](https://mui.com/material-ui/getting-started/versions/)

## 9.0.0

Expand Down
1 change: 0 additions & 1 deletion docs/data/docs/pages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import type { MuiPage } from '@mui/internal-core-docs/MuiPage';
import { standardNavIcons } from '@mui/internal-core-docs/AppLayout';

const pages: readonly MuiPage[] = [
{ pathname: 'https://mui.com/versions/' },
{
pathname: 'https://mui.com/store/',
title: 'Templates',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<p class="description">This package hosts the incubator components that are not yet ready to move to the core.</p>

The main difference between the lab and the core is how the components are versioned. Having a separate lab package allows us to release breaking changes when necessary while the core package follows a [slower-moving policy](https://mui.com/versions/#release-frequency).
The main difference between the lab and the core is how the components are versioned. Having a separate lab package allows us to release breaking changes when necessary while the core package follows a [slower-moving policy](/material-ui/getting-started/versions/#release-frequency).

Check warning on line 5 in docs/data/material/components/about-the-lab/about-the-lab.md

View workflow job for this annotation

GitHub Actions / test-dev (ubuntu-latest)

[vale] reported by reviewdog 🐶 [Google.We] Try to avoid using first-person plural like 'us'. Raw Output: {"message": "[Google.We] Try to avoid using first-person plural like 'us'.", "location": {"path": "docs/data/material/components/about-the-lab/about-the-lab.md", "range": {"start": {"line": 5, "column": 124}}}, "severity": "WARNING"}

As developers use and test the components and report issues, the maintainers learn more about shortcomings of the components: missing features, accessibility issues, bugs, API design, etc. The older and more used a component is, the less likely it is that new issues will be found and subsequently need to introduce breaking changes.

Expand Down
2 changes: 1 addition & 1 deletion docs/data/material/getting-started/support/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ If you can't find your answer, [ask a new question](https://stackoverflow.com/qu

:::success
If you're using an older version of Material UI, you may find answers on SO with links to content that no longer exists in the latest version of the documentation.
Visit the [Material UI Versions](https://mui.com/versions/) page to find the archived documentation that corresponds to your version.
Visit the [Material UI Versions](https://mui.com/material-ui/getting-started/versions/) page to find the archived documentation that corresponds to your version.
:::

## Technical support
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The objective is to support Node.js down to the [last version in maintenance mod
<!-- #react-peer-version -->

Material UI supports the most recent versions of React, starting with ^17.0.0 (the one with event delegation at the React root).
Have a look at the older [versions](https://mui.com/versions/) for backward compatibility.
Have a look at the older [versions](https://mui.com/material-ui/getting-started/versions/) for backward compatibility.

## TypeScript

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ import TableCell from '@mui/material/TableCell';
import TableRow from '@mui/material/TableRow';
import Typography from '@mui/material/Typography';
import { Link } from '@mui/internal-core-docs/Link';
import VersionsContext from 'docs/src/pages/versions/VersionsContext';
import { VersionsContext } from '@mui/internal-core-docs/DocsApp';

const GITHUB_RELEASE_BASE_URL = 'https://github.com/mui/material-ui/releases/tag/';

function ReleasedVersions() {
const versions = React.useContext(VersionsContext);
const versions = React.useContext(VersionsContext) ?? [];

return (
<Box sx={{ minHeight: 33 * 11, overflow: 'auto', width: '100%' }}>
Expand All @@ -22,7 +22,11 @@ function ReleasedVersions() {
<TableCell>
<Typography variant="body2">
{doc.version}
{doc.version === `v${process.env.LIB_VERSION}` ? ' ✓' : ''}
{doc.version.startsWith(
`v${process.env.LIB_VERSION.split('.')[0]}`,
)
? ' ✓'
: ''}
</Typography>
</TableCell>
<TableCell>
Expand All @@ -31,11 +35,11 @@ function ReleasedVersions() {
</Link>
</TableCell>
<TableCell>
{doc.version.length >= 6 && !doc.version.includes('pre-release') ? (
{!doc.noReleaseNotes ? (
<Link
variant="body2"
rel="nofollow"
href={`${GITHUB_RELEASE_BASE_URL}${doc.version}`}
href={`${GITHUB_RELEASE_BASE_URL}${doc.version}.0.0`}
>
Release notes
</Link>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@

The most recent stable version (✓) is recommended for use in production.

{{"demo": "pages/versions/ReleasedVersions.js", "hideToolbar": true, "bg": "inline"}}
{{"demo": "ReleasedVersions.js", "hideToolbar": true, "bg": "inline"}}

## Latest versions

Here you can find the latest unreleased documentation and code.
You can use it to see what changes are coming and provide better feedback to contributors.

{{"demo": "pages/versions/LatestVersions.js", "hideToolbar": true, "bg": "inline"}}
{{"demo": "LatestVersions.js", "hideToolbar": true, "bg": "inline"}}

## Versioning strategy

Expand Down Expand Up @@ -55,13 +55,14 @@ A regular schedule of releases helps you plan and coordinate your updates with t
In general, you can expect the following release cycle:

- A **major** release every 12 months.
- 1-3 **minor** releases for each major release.
- A **patch** release every week (anytime for an urgent bug fix).
- A few **minor** releases for each major release.
- A **patch** release every month (anytime for an urgent bug fix).

## Release schedule

| Date | Version | Status |
| :------------- | :------ | :------- |
| April 2026 | v9.0.0 | Released |
| March 2025 | v7.0.0 | Released |
| August 2024 | v6.0.0 | Released |
| September 2021 | v5.0.0 | Released |
Expand Down
2 changes: 1 addition & 1 deletion docs/data/material/migration/migration-v3/migration-v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<p class="description">Yeah, v4 has been released!</p>

Looking for the v3 docs? You can [find the latest version here](https://mui.com/versions/).
Looking for the v3 docs? You can [find the latest version here](https://mui.com/material-ui/getting-started/versions/).

:::info
This document is a work in progress.
Expand Down
1 change: 1 addition & 0 deletions docs/data/material/pages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ const pages: MuiPage[] = [
{ pathname: '/material-ui/getting-started/supported-components' },
{ pathname: '/material-ui/getting-started/supported-platforms' },
{ pathname: '/material-ui/getting-started/support' },
{ pathname: '/material-ui/getting-started/versions' },
],
},
{
Expand Down
Binary file removed docs/mui-vale.zip
Binary file not shown.
2 changes: 0 additions & 2 deletions docs/mui-vale/.vale.ini

This file was deleted.

43 changes: 0 additions & 43 deletions docs/mui-vale/styles/MUI/CorrectReferenceAllCases.yml

This file was deleted.

14 changes: 0 additions & 14 deletions docs/mui-vale/styles/MUI/CorrectRererenceCased.yml

This file was deleted.

11 changes: 0 additions & 11 deletions docs/mui-vale/styles/MUI/GoogleLatin.yml

This file was deleted.

22 changes: 0 additions & 22 deletions docs/mui-vale/styles/MUI/MuiBrandName.yml

This file was deleted.

Loading
Loading