diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index ccc762342e454..8ca5ebde97e09 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -19,12 +19,12 @@ jobs: LABEL: ci PR_BRANCH: ci/docgen PR_TITLE: 'ci: update configuration reference docs' - # Custom options for running with Astro v6 beta code - # - SOURCE_BRANCH: main - # TARGET_BRANCH: v6 - # LABEL: 6.0,ci - # PR_BRANCH: ci/docgen-beta - # PR_TITLE: '[BETA] ci: update reference docs' + # Custom options for running with Astro v7 beta code + - SOURCE_BRANCH: next + TARGET_BRANCH: v7 + LABEL: 7.0,ci + PR_BRANCH: ci/docgen-beta + PR_TITLE: '[BETA] ci: update reference docs' steps: - name: Check out code using Git uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 @@ -66,12 +66,12 @@ jobs: LABEL: ci PR_BRANCH: ci/docgen-errors PR_TITLE: 'ci: update error reference docs' - # Custom options for running with Astro v6 beta code - # - SOURCE_BRANCH: main - # TARGET_BRANCH: v6 - # LABEL: 6.0,ci - # PR_BRANCH: ci/docgen-errors-beta - # PR_TITLE: '[BETA] ci: update error reference docs' + # Custom options for running with Astro v7 beta code + - SOURCE_BRANCH: next + TARGET_BRANCH: v7 + LABEL: 7.0,ci + PR_BRANCH: ci/docgen-errors-beta + PR_TITLE: '[BETA] ci: update error reference docs' steps: - name: Check out code using Git uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 diff --git a/astro.sidebar.ts b/astro.sidebar.ts index c808283eaf9f9..6fb3c17e19646 100644 --- a/astro.sidebar.ts +++ b/astro.sidebar.ts @@ -88,6 +88,7 @@ export const sidebar = [ group('guides.upgrade.major', { collapsed: true, items: [ + 'guides/upgrade-to/v7', 'guides/upgrade-to/v6', 'guides/upgrade-to/v5', 'guides/upgrade-to/v4', @@ -160,7 +161,6 @@ export const sidebar = [ 'reference/experimental-flags/chrome-devtools-workspace', 'reference/experimental-flags/svg-optimization', 'reference/experimental-flags/queued-rendering', - 'reference/experimental-flags/rust-compiler', 'reference/experimental-flags/advanced-routing', 'reference/experimental-flags/logger', ], diff --git a/public/_headers b/public/_headers index b505fec8b57ad..3967f74787ff9 100644 --- a/public/_headers +++ b/public/_headers @@ -1,3 +1,6 @@ +# TODO: Remove this before merging to main +/* + x-robots-tag: no-index /* cache-control: max-age=60 cache-control: public @@ -5,3 +8,4 @@ cache-control: max-age=31536000 cache-control: immutable cache-control: public + diff --git a/src/content/docs/en/getting-started.mdx b/src/content/docs/en/getting-started.mdx index 030c0002ecd8c..dcb3791c0c4b2 100644 --- a/src/content/docs/en/getting-started.mdx +++ b/src/content/docs/en/getting-started.mdx @@ -7,7 +7,7 @@ editUrl: false next: false banner: content: | - Astro v6 is here! Learn how to upgrade your site + Astro v7 is here! Learn how to upgrade your site hero: title: Astro Docs tagline: Guides, resources, and API references to help you build with Astro. diff --git a/src/content/docs/en/guides/upgrade-to/v7.mdx b/src/content/docs/en/guides/upgrade-to/v7.mdx new file mode 100644 index 0000000000000..d4c9be4c68375 --- /dev/null +++ b/src/content/docs/en/guides/upgrade-to/v7.mdx @@ -0,0 +1,101 @@ +--- +title: Upgrade to Astro v7 +description: How to upgrade your project to Astro v7.0. +sidebar: + label: v7.0 +i18nReady: false +--- +import PackageManagerTabs from '~/components/tabs/PackageManagerTabs.astro' +import { Steps } from '@astrojs/starlight/components'; +import ReadMore from '~/components/ReadMore.astro' +import SourcePR from '~/components/SourcePR.astro' + +:::tip[Using a coding agent?] +Copy this prompt to upgrade your project: + +``` +Upgrade my Astro project to v7. Follow the migration guide at +https://v7.docs.astro.build/en/guides/upgrade-to/v7/ +``` +::: + +This guide will help you migrate from Astro v6 to Astro v7. + +Need to upgrade an older project to v6 first? See our [older migration guide](/en/guides/upgrade-to/v6/). + +Need to see the v6 docs? Visit this [older version of the docs site (unmaintained v6 snapshot)](https://v6.docs.astro.build/). + +## Upgrade Astro + +Update your project's version of Astro to the latest version using your package manager: + + + + ```shell + # Upgrade Astro and official integrations together + npx @astrojs/upgrade alpha + ``` + + + ```shell + # Upgrade Astro and official integrations together + pnpm dlx @astrojs/upgrade alpha + ``` + + + ```shell + # Upgrade Astro and official integrations together + yarn dlx @astrojs/upgrade alpha + ``` + + + +You can also [upgrade your Astro integrations manually](/en/guides/integrations/#manual-upgrading) if needed, and you may also need to upgrade other dependencies in your project. + +:::note[Need to continue?] +After upgrading Astro, you may not need to make any changes to your project at all! + +But, if you notice errors or unexpected behavior, please check below for what has changed that might need updating in your project. +::: + +Astro v7.0 includes [potentially breaking changes](#breaking-changes), as well as the removal of some previously deprecated features. + +If your project doesn't work as expected after upgrading to v7.0, check this guide for an overview of all breaking changes and instructions on how to update your codebase. + +See [the Astro changelog](https://github.com/withastro/astro/blob/main/packages/astro/CHANGELOG.md) for full release notes. + +## Breaking Changes + +### Dependency Upgrades + +#### Vite 8 + +Astro v7.0 upgrades to [Vite 8](https://vite.dev/blog/announcing-vite-8) as the development server and production bundler. + +##### What should I do? + +If you are using Vite-specific plugins, configuration, or APIs, check the [Vite 8 migration guide](https://vite.dev/guide/migration) for their breaking changes and upgrade your project as needed. + +Most Astro users should be able to upgrade without any changes to their project code. This is primarily a breaking change for Astro integrations and plugins that depend on Vite internals. + +### Rust Compiler + +The Rust-based Astro compiler, previously available as an experimental flag (`experimental.rustCompiler`), is now the default and only compiler in Astro 7. The Rust compiler delivers significantly faster build times compared to the previous Go-based compiler. + +##### What should I do? + +No action is required for most projects. The Rust compiler is a drop-in replacement for the Go-based compiler. + +If you had previously opted in to the Rust compiler via the experimental flag, you can now remove it from your configuration: + +```js title="astro.config.mjs" del={4-6} +import { defineConfig } from 'astro/config'; + +export default defineConfig({ + experimental: { + rustCompiler: true, + }, +}); +``` + +If you encounter any issues with the Rust compiler, please report them on [GitHub](https://github.com/withastro/astro/issues). diff --git a/src/content/docs/en/reference/experimental-flags/rust-compiler.mdx b/src/content/docs/en/reference/experimental-flags/rust-compiler.mdx deleted file mode 100644 index 7c4b4d9073be2..0000000000000 --- a/src/content/docs/en/reference/experimental-flags/rust-compiler.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: Experimental Rust compiler -sidebar: - label: Rust compiler -i18nReady: true ---- - -import Since from '~/components/Since.astro' -import PackageManagerTabs from '~/components/tabs/PackageManagerTabs.astro' - -

- - **Type:** `boolean`
- **Default:** `false`
- -

- -Enables using the new Rust-based compiler for Astro files. This compiler is faster, provides better error messages, and generally has better support for modern JavaScript, TypeScript, and CSS features. - -In a future major version, Astro will use this new compiler by default, but you can opt in to the future behavior early using the `experimental.rustCompiler` flag. - -To give feedback on the compiler, or to keep up with its development, see the [RFC for a new compiler for Astro](https://github.com/withastro/roadmap/discussions/1306) for more information and discussion. - -## Usage - -This experimental flag requires no specific usage and only affects which compiler Astro uses for your project. - -To enable the Rust compiler, add the following to your `astro.config.mjs`: - -```js title="astro.config.mjs" ins={4-6} -import { defineConfig } from "astro/config"; - -export default defineConfig({ - experimental: { - rustCompiler: true - } -}); -``` - -and then install the `@astrojs/compiler-rs` package into your project: - - - - ```shell - npm install @astrojs/compiler-rs - ``` - - - ```shell - pnpm add @astrojs/compiler-rs - ``` - - - ```shell - yarn add @astrojs/compiler-rs - ``` - - - -### Expected differences - -Unlike Astro's current Go compiler, this experimental Rust compiler will not correct invalid HTML structure. For example, the following notable patterns will be left as written, and no longer corrected: - - - `

Bad nesting

` (instead of removing the `div` from of the `p`) - - `

My paragraph` (instead of adding the missing closing `

` tag) - -This means that if your Astro files contain invalid HTML, you may see a different output from the Rust compiler than you did with the previous compiler, or may encounter errors while building. - -## Limitations - -At this time, the Rust compiler does not output the required metadata for the dev toolbar audits to work correctly. diff --git a/src/content/docs/en/upgrade-astro.mdx b/src/content/docs/en/upgrade-astro.mdx index 0e5fb1dac497a..0df056043e4b7 100644 --- a/src/content/docs/en/upgrade-astro.mdx +++ b/src/content/docs/en/upgrade-astro.mdx @@ -102,6 +102,7 @@ The main Astro documentation pages are always **accurate for the latest released See the upgrade guides below for an explanation of changes, comparing the new version to the old. The upgrade guides include everything that could require you to change your own code: breaking changes, deprecations, feature removals and replacements as well as updated usage guidance. Each change to Astro includes a "What should I do?" section to help you successfully update your project code. +- [Upgrade to v7](/en/guides/upgrade-to/v7/) - [Upgrade to v6](/en/guides/upgrade-to/v6/) - [Upgrade to v5](/en/guides/upgrade-to/v5/) - [Upgrade to v4](/en/guides/upgrade-to/v4/) diff --git a/src/content/docs/es/reference/experimental-flags/rust-compiler.mdx b/src/content/docs/es/reference/experimental-flags/rust-compiler.mdx deleted file mode 100644 index c65202c2b84c8..0000000000000 --- a/src/content/docs/es/reference/experimental-flags/rust-compiler.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: Compilador experimental en Rust -sidebar: - label: Compilador en Rust -i18nReady: true ---- - -import Since from '~/components/Since.astro' -import PackageManagerTabs from '~/components/tabs/PackageManagerTabs.astro' - -

- - **Tipo:** `boolean`
- **Por defecto:** `false`
- -

- -Habilita el uso del nuevo compilador de Astro basado en Rust para archivos Astro. Este compilador es más rápido, ofrece mejores mensajes de error y, en general, mejor soporte para funcionalidades modernas de JavaScript, TypeScript y CSS. - -En una futura versión mayor, Astro usará este nuevo compilador por defecto, pero puedes adelantar ese comportamiento usando el flag `experimental.rustCompiler`. - -Para dar feedback sobre el compilador o seguir su desarrollo, consulta la [RFC del nuevo compilador de Astro](https://github.com/withastro/roadmap/discussions/1306) para más información y discusión. - -## Uso - -Este flag experimental no requiere uso específico y solo afecta a qué compilador usa Astro en tu proyecto. - -Para habilitar el compilador en Rust, agrega lo siguiente en tu `astro.config.mjs`: - -```js title="astro.config.mjs" ins={4-6} -import { defineConfig } from "astro/config"; - -export default defineConfig({ - experimental: { - rustCompiler: true - } -}); -``` - -y luego instala el paquete `@astrojs/compiler-rs` en tu proyecto: - - - - ```shell - npm install @astrojs/compiler-rs - ``` - - - ```shell - pnpm add @astrojs/compiler-rs - ``` - - - ```shell - yarn add @astrojs/compiler-rs - ``` - - - -### Diferencias esperadas - -A diferencia del compilador actual de Astro (Go), este compilador experimental en Rust no corregirá automáticamente estructuras HTML inválidas. Por ejemplo, estos patrones se dejarán tal como están y ya no se corregirán: - -- `

Bad nesting

` (en lugar de sacar el `div` fuera del `p`) -- `

My paragraph` (en lugar de añadir la etiqueta de cierre `

` faltante) - -Esto significa que, si tus archivos Astro contienen HTML inválido, puedes ver un resultado distinto con el compilador en Rust respecto al compilador anterior, o encontrar errores durante el build. - -## Limitaciones - -Actualmente, el compilador en Rust no genera los metadatos necesarios para que las auditorías de la barra de herramientas de desarrollo funcionen correctamente. diff --git a/src/content/docs/fr/reference/experimental-flags/rust-compiler.mdx b/src/content/docs/fr/reference/experimental-flags/rust-compiler.mdx deleted file mode 100644 index 502d42ac1e685..0000000000000 --- a/src/content/docs/fr/reference/experimental-flags/rust-compiler.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: Compilateur Rust expérimental -sidebar: - label: Compilateur Rust -i18nReady: true ---- - -import Since from '~/components/Since.astro' -import PackageManagerTabs from '~/components/tabs/PackageManagerTabs.astro' - -

- - **Type :** `boolean`
- **Par défaut :** `false`
- -

- -Active le nouveau compilateur de fichiers Astro implémenté avec Rust. Ce compilateur est plus rapide, fournit de meilleurs messages d'erreur, et de manière générale a une meilleure prise en charge des fonctionnalités modernes de JavaScript, TypeScript et CSS. - -Dans une future version majeure, Astro utilisera ce nouveau compilateur par défaut, mais vous pouvez activer ce comportement futur dès maintenant en utilisant l'option `experimental.rustCompiler`. - -Pour faire part de vos commentaires sur le compilateur ou bien pour suivre son développement, consultez la [RFC relative au nouveau compilateur d'Astro](https://github.com/withastro/roadmap/discussions/1306) pour plus d'informations et discussions. - -## Utilisation - -Cette option expérimentale ne nécessite aucune utilisation spécifique et concerne seulement le compilateur qu'Astro utilise pour votre projet. - -Pour activer le compilateur Rust, ajoutez le code suivant à votre fichier `astro.config.mjs` : - -```js title="astro.config.mjs" ins={4-6} -import { defineConfig } from "astro/config"; - -export default defineConfig({ - experimental: { - rustCompiler: true - } -}); -``` - -et installez ensuite le paquet `@astrojs/compiler-rs` dans votre projet : - - - - ```shell - npm install @astrojs/compiler-rs - ``` - - - ```shell - pnpm add @astrojs/compiler-rs - ``` - - - ```shell - yarn add @astrojs/compiler-rs - ``` - - - -### Différences attendues - -Contrairement au compilateur Astro actuel écrit en Go, ce compilateur Rust expérimental ne corrigera pas les structures HTML invalides. Par exemple, les modèles notables suivants seront laissés tels quels, et ne seront plus corrigés : - - - `

Mauvaise imbrication

` (au lieu de supprimer la balise `div` de la balise `p`) - - `

Mon paragraphe` (au lieu d'ajouter la balise `

` manquante) - -Cela signifie que si vos fichiers Astro contiennent du code HTML invalide, vous pourriez obtenir un résultat différent avec le compilateur Rust par rapport au compilateur précédent, ou rencontrer des erreurs lors de la compilation. - -## Limitations - -À l'heure actuelle, le compilateur Rust ne génère pas les métadonnées nécessaires au bon fonctionnement des audits de la barre d'outils de développement. diff --git a/src/content/docs/ja/reference/experimental-flags/rust-compiler.mdx b/src/content/docs/ja/reference/experimental-flags/rust-compiler.mdx deleted file mode 100644 index 80bbb666ce926..0000000000000 --- a/src/content/docs/ja/reference/experimental-flags/rust-compiler.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: 試験的なRustコンパイラー -sidebar: - label: Rustコンパイラー -i18nReady: true ---- - -import Since from '~/components/Since.astro' -import PackageManagerTabs from '~/components/tabs/PackageManagerTabs.astro' - -

- - **Type:** `boolean`
- **Default:** `false`
- -

- -AstroファイルにRustベースの新しいコンパイラーを使用できるようにします。このコンパイラーはより高速で、エラーメッセージがわかりやすく、モダンなJavaScript・TypeScript・CSSの機能に対して全般的に優れたサポートを提供します。 - -将来のメジャーバージョンでは、Astroはデフォルトでこの新しいコンパイラーを使用するようになりますが、`experimental.rustCompiler`フラグを使用することで、いち早く将来の動作を試すことができます。 - -コンパイラーへのフィードバックや開発状況を確認するには、[Astroの新しいコンパイラーに関するRFC](https://github.com/withastro/roadmap/discussions/1306)をご参照ください。 - -## 使い方 - -この試験的なフラグは特定の使い方を必要とせず、Astroがプロジェクトに使用するコンパイラーにのみ影響します。 - -Rustコンパイラーを有効にするには、`astro.config.mjs`に以下を追加します。 - -```js title="astro.config.mjs" ins={4-6} -import { defineConfig } from "astro/config"; - -export default defineConfig({ - experimental: { - rustCompiler: true - } -}); -``` - -次に、`@astrojs/compiler-rs`パッケージをプロジェクトにインストールします。 - - - - ```shell - npm install @astrojs/compiler-rs - ``` - - - ```shell - pnpm add @astrojs/compiler-rs - ``` - - - ```shell - yarn add @astrojs/compiler-rs - ``` - - - -### 動作の違いについて - -AstroのGoコンパイラーとは異なり、この試験的なRustコンパイラーは無効なHTML構造を修正しません。たとえば、以下のようなパターンはそのまま出力され、自動修正されなくなります。 - - - `

Bad nesting

`（`p`タグから`div`を除去する代わりに） - - `

My paragraph` (閉じタグ`

`を補完する代わりに) - -そのため、Astroファイルに無効なHTMLが含まれている場合、Rustコンパイラーによる出力が以前のコンパイラーと異なる場合や、ビルド時にエラーが発生する場合があります。 - -## 制限事項 - -現時点では、Rustコンパイラーはdevツールバーの監査が正しく機能するために必要なメタデータを出力しません。 diff --git a/src/content/docs/ko/reference/experimental-flags/rust-compiler.mdx b/src/content/docs/ko/reference/experimental-flags/rust-compiler.mdx deleted file mode 100644 index cefc0c0bdff96..0000000000000 --- a/src/content/docs/ko/reference/experimental-flags/rust-compiler.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: 실험적 Rust 컴파일러 -sidebar: - label: Rust 컴파일러 -i18nReady: true ---- - -import Since from '~/components/Since.astro' -import PackageManagerTabs from '~/components/tabs/PackageManagerTabs.astro' - -

- - **타입:** `boolean`
- **기본값:** `false`
- -

- -Astro 파일에 대해 새로운 Rust 기반 컴파일러 사용을 활성화합니다. 이 컴파일러는 더 빠르고, 더 나은 오류 메시지를 제공하며, 전반적으로 현대적인 JavaScript, TypeScript 및 CSS 기능을 더 잘 지원합니다. - -Astro의 향후 주요 버전에서는 이 새로운 컴파일러가 기본으로 사용될 예정이지만, `experimental.rustCompiler` 플래그를 사용하여 미래의 동작을 미리 선택할 수 있습니다. - -컴파일러에 대한 피드백을 제공하거나 개발 상황을 확인하려면 [Astro를 위한 새로운 컴파일러 RFC](https://github.com/withastro/roadmap/discussions/1306)에서 자세한 정보와 토론을 확인하세요. - -## 사용법 - -이 실험적 플래그는 특별한 사용법이 필요하지 않으며, 프로젝트에서 Astro가 사용하는 컴파일러에만 영향을 미칩니다. - -Rust 컴파일러를 활성화하려면 `astro.config.mjs`에 다음을 추가하세요: - -```js title="astro.config.mjs" ins={4-6} -import { defineConfig } from "astro/config"; - -export default defineConfig({ - experimental: { - rustCompiler: true - } -}); -``` - -그런 다음 프로젝트에 `@astrojs/compiler-rs` 패키지를 설치하세요: - - - - ```shell - npm install @astrojs/compiler-rs - ``` - - - ```shell - pnpm add @astrojs/compiler-rs - ``` - - - ```shell - yarn add @astrojs/compiler-rs - ``` - - - -### 예상되는 차이점 - -Astro의 현재 Go 컴파일러와 달리, 이 실험적인 Rust 컴파일러는 잘못된 HTML 구조를 수정하지 않습니다. 예를 들어, 다음과 같은 주요 패턴은 작성된 대로 유지되며 더 이상 수정되지 않습니다: - - - `

Bad nesting

` (`p` 태그 내부의 `div`를 제거하는 대신) - - `

My paragraph` (누락된 닫는 `

` 태그를 추가하는 대신) - -즉, Astro 파일에 잘못된 HTML이 포함되어 있으면 이전 컴파일러를 사용했을 때와 출력이 다르거나 빌드 중에 오류가 발생할 수 있습니다. - -## 제한 사항 - -현재 Rust 컴파일러는 개발 툴바 감사가 올바르게 작동하는 데 필요한 메타데이터를 출력하지 않습니다.