Merge branch 'main' into cluster-light-probes

.cargo/config_fast_builds.toml

@@ -7,9 +7,9 @@
 #
 # ## LLD
 #
-# LLD is a linker from the LLVM project that supports Linux, Windows, MacOS, and WASM. It has the greatest
+# LLD is a linker from the LLVM project that supports Linux, Windows, macOS, and Wasm. It has the greatest
 # platform support and the easiest installation process. It is enabled by default in this file for Linux
-# and Windows. On MacOS, the default linker yields higher performance than LLD and is used instead.
+# and Windows. On macOS, the default linker yields higher performance than LLD and is used instead.
 #
 # To install, please scroll to the corresponding table for your target (eg. `[target.x86_64-pc-windows-msvc]`
 # for Windows) and follow the steps under `LLD linker`.
@@ -25,7 +25,7 @@
 # your corresponding target, disable LLD by commenting out its `-Clink-arg=...` line, and enable Mold by
 # *uncommenting* its `-Clink-arg=...` line.
 #
-# There is a fork of Mold named Sold that supports MacOS, but it is unmaintained and is about the same speed as
+# There is a fork of Mold named Sold that supports macOS, but it is unmaintained and is about the same speed as
 # the default ld64 linker. For this reason, it is not included in this file.
 #
 # For more information, please see Mold's repository at <https://github.com/rui314/mold>.
@@ -83,12 +83,21 @@ rustflags = [
   # - Ubuntu: `sudo apt-get install mold clang`
   # - Fedora: `sudo dnf install mold clang`
   # - Arch: `sudo pacman -S mold clang`
-  # "-Clink-arg=-fuse-ld=/usr/bin/mold",
+  # "-Clink-arg=-fuse-ld=mold",
 
   # Nightly
   # "-Zshare-generics=y",
   # "-Zthreads=0",
 ]
+# Some systems may experience linker performance issues when running doc tests.
+# See https://github.com/bevyengine/bevy/issues/12207 for details.
+rustdocflags = [
+  # LLD linker
+  "-Clink-arg=-fuse-ld=lld",
+
+  # Mold linker
+  # "-Clink-arg=-fuse-ld=mold",
+]
 
 [target.x86_64-apple-darwin]
 rustflags = [
@@ -134,18 +143,19 @@ rustflags = [
 # rustup component add llvm-tools
 # ```
 linker = "rust-lld.exe"
+rustdocflags = ["-Clinker=rust-lld.exe"]
 rustflags = [
   # Nightly
-  # "-Zshare-generics=y",
+  # "-Zshare-generics=n", # This needs to be off if you use dynamic linking on Windows.
   # "-Zthreads=0",
 ]
 
 # Optional: Uncommenting the following improves compile times, but reduces the amount of debug info to 'line number tables only'
-# In most cases the gains are negligible, but if you are on macos and have slow compile times you should see significant gains.
+# In most cases the gains are negligible, but if you are on macOS and have slow compile times you should see significant gains.
 # [profile.dev]
 # debug = 1
 
-# This is enables you to run the CI tool using `cargo ci`.
+# This enables you to run the CI tool using `cargo ci`.
 # This is not enabled by default, you need to copy this file to `config.toml`.
 [alias]
 ci = "run --package ci --"

.github/ISSUE_TEMPLATE/docs_improvement.md

@@ -10,4 +10,4 @@ assignees: ''
 
 Provide a link to the documentation and describe how it could be improved. In what ways is it incomplete, incorrect, or misleading?
 
-If you have suggestions on exactly what the new docs should say, feel free to include them here. Or alternatively, make the changes yourself and [create a pull request](https://bevyengine.org/learn/book/contributing/code/) instead.
+If you have suggestions on exactly what the new docs should say, feel free to include them here. Alternatively, make the changes yourself and [create a pull request](https://bevyengine.org/learn/book/contributing/code/) instead.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -2,7 +2,7 @@
 name: Feature Request
 about: Propose a new feature!
 title: ''
-labels: C-Enhancement, S-Needs-Triage
+labels: C-Feature, S-Needs-Triage
 assignees: ''
 ---
 

.github/actions/install-linux-deps/action.yml

@@ -12,27 +12,27 @@
 # repository before you can use this action.
 #
 # This action will only install dependencies when the current operating system is Linux. It will do
-# nothing on any other OS (MacOS, Windows).
+# nothing on any other OS (macOS, Windows).
 
 name: Install Linux dependencies
 description: Installs the dependencies necessary to build Bevy on Linux.
 inputs:
   alsa:
     description: Install alsa (libasound2-dev)
     required: false
-    default: true
+    default: "true"
   udev:
     description: Install udev (libudev-dev)
     required: false
-    default: true
+    default: "true"
   wayland:
     description: Install Wayland (libwayland-dev)
     required: false
-    default: false
+    default: "false"
   xkb:
     description: Install xkb (libxkbcommon-dev)
     required: false
-    default: false
+    default: "false"
 runs:
   using: composite
   steps:

.github/example-run/ambiguity_detection.ron

@@ -0,0 +1,2 @@
+(
+)

.github/linters/.markdown-lint.yml

@@ -1,3 +1,9 @@
 {
-    "MD013": false
+    "MD013": false,
+    "no-inline-html": {
+        "allowed_elements": [
+            "details",
+            "summary"
+        ]
+    }
 }

.github/pull_request_template.md

@@ -16,14 +16,26 @@
 
 ---
 
-## Changelog
+## Showcase
 
-> This section is optional. If this was a trivial fix, or has no externally-visible impact, you can delete this section.
+> This section is optional. If this PR does not include a visual change or does not add a new feature, you can delete this section.
 
-- What changed as a result of this PR?
-- If applicable, organize changes under "Added", "Changed", or "Fixed" sub-headings
-- Stick to one or two sentences. If more detail is needed for a particular change, consider adding it to the "Solution" section
-  - If you can't summarize the work, your change may be unreasonably large / unrelated. Consider splitting your PR to make it easier to review and merge!
+- Help others understand the result of this PR by showcasing your awesome work!
+- If this PR adds a new feature or public API, consider adding a brief pseudo-code snippet of it in action
+- If this PR includes a visual change, consider adding a screenshot, GIF, or video
+  - If you want, you could even include a before/after comparison!
+- If the Migration Guide adequately covers the changes, you can delete this section
+
+While a showcase should aim to be brief and digestible, you can use a toggleable section to save space on longer showcases:
+
+<details>
+  <summary>Click to view showcase</summary>
+
+```rust
+println!("My super cool code.");
+```
+
+</details>
 
 ## Migration Guide
 

.github/start-wasm-example/tests/wasm_example.spec.ts

@@ -6,7 +6,7 @@ test.beforeEach(async ({ page }) => {
 
 const MAX_TIMEOUT_FOR_TEST = 300_000;
 
-test.describe('WASM example', () => {
+test.describe('Wasm example', () => {
   test('Wait for success', async ({ page }, testInfo) => {
     let start = new Date().getTime();
 

.github/workflows/ci-examples.yml

@@ -0,0 +1,77 @@
+name: CI  - examples
+
+on:
+  merge_group:
+  pull_request_target:
+  push:
+    branches:
+      - main
+      - release-*
+
+# Unlike jobs in ci.yml, jobs in this workflow can access secrets. Their definitions are taken from the base branch of a PR, not from the PR itself.
+
+env:
+  CARGO_TERM_COLOR: always
+  # If nightly is breaking CI, modify this variable to target a specific nightly version.
+  NIGHTLY_TOOLCHAIN: nightly
+
+concurrency:
+  group: ${{github.workflow}}-${{github.ref}}-examples
+  cancel-in-progress: ${{github.event_name == 'pull_request_target'}}
+
+jobs:
+  run-examples-macos-metal:
+    # Explicity use macOS 14 to take advantage of M1 chip.
+    runs-on: macos-14
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - name: Disable audio
+        # Disable audio through a patch. on github m1 runners, audio timeouts after 15 minutes
+        run: git apply --ignore-whitespace tools/example-showcase/disable-audio.patch
+      - name: Build bevy
+        # this uses the same command as when running the example to ensure build is reused
+        run: |
+          TRACE_CHROME=trace-alien_cake_addict.json CI_TESTING_CONFIG=.github/example-run/alien_cake_addict.ron cargo build --example alien_cake_addict --features "bevy_ci_testing,trace,trace_chrome"
+      - name: Run examples
+        run: |
+          for example in .github/example-run/*.ron; do
+            example_name=`basename $example .ron`
+            echo -n $example_name > last_example_run
+            echo "running $example_name - "`date`
+            time TRACE_CHROME=trace-$example_name.json CI_TESTING_CONFIG=$example cargo run --example $example_name --features "bevy_ci_testing,trace,trace_chrome"
+            sleep 10
+            if [ `find ./ -maxdepth 1 -name 'screenshot-*.png' -print -quit` ]; then
+              mkdir screenshots-$example_name
+              mv screenshot-*.png screenshots-$example_name/
+            fi
+          done
+          mkdir traces && mv trace*.json traces/
+          mkdir screenshots && mv screenshots-* screenshots/
+      - name: save traces
+        uses: actions/upload-artifact@v4
+        with:
+          name: example-traces-macos
+          path: traces
+      - name: save screenshots
+        uses: actions/upload-artifact@v4
+        with:
+          name: screenshots-macos
+          path: screenshots
+      - uses: actions/upload-artifact@v4
+        if: ${{ failure() && github.event_name == 'pull_request' }}
+        with:
+          name: example-run-macos
+          path: example-run/
+
+  compare-macos-screenshots:
+    name: Compare macOS screenshots
+    needs: [run-examples-macos-metal]
+    uses: ./.github/workflows/send-screenshots-to-pixeleagle.yml
+    with:
+      commit: ${{ github.sha }}
+      branch: ${{ github.ref_name }}
+      artifact: screenshots-macos
+      os: macos
+    secrets: inherit