Merge branch 'main' into 0.13-blog

Author: cart

.gitattributes

@@ -0,0 +1,32 @@
+# From: https://docs.github.com/en/github/getting-started-with-github/configuring-git-to-handle-line-endings
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Explicitly declare text files you want to always be normalized and converted
+# to native line endings on checkout.
+*.rs text eol=lf
+*.toml text eol=lf
+*.frag text eol=lf
+*.vert text eol=lf
+*.wgsl text eol=lf
+*.md text eof=lf
+*.html text eof=lf
+*.scss text eof=lf
+*.js text eof=lf
+*.mjs text eof=lf
+*.svg text eof=lf
+*.txt text eof=lf
+*.xml text eof=lf
+*.yml text eof=lf
+*.sh text eof=lf
+
+# Denote all files that are truly binary and should not be modified.
+*.png binary
+*.jpg binary
+*.gif binary
+*.webp binary
+*.ttf binary
+*.woff binary
+*.woff2 binary
+*.eot binary
+*.mp4 binary

.github/bors.toml

@@ -1,5 +1,5 @@
-# Keep synced with duplicate in project root
-
-line-length: false
-no-inline-html: false
-no-trailing-punctuation: false
+# Keep synced with duplicate in project root
+
+line-length: false
+no-inline-html: false
+no-trailing-punctuation: false

.github/linters/.markdown-lint.yml

@@ -18,14 +18,14 @@ jobs:
     steps:
 
       - name: Checkout Bevy latest tag
-        uses: actions/checkout@master
+        uses: actions/checkout@v4
         with:
           repository: 'bevyengine/bevy'
           ref: 'latest'
 
       # temporary: fetch tools from main branch
       - name: Checkout Bevy Tools
-        uses: actions/checkout@master
+        uses: actions/checkout@v4
         with:
           repository: 'bevyengine/bevy'
           ref: 'main'
@@ -52,7 +52,7 @@ jobs:
           cargo run -p example-showcase -- --per-page ${{ env.PER_PAGE }} --page ${{ matrix.page }} build-wasm-examples --content-folder wasm-examples --api ${{ matrix.api }} --website-hacks --optimize-size
 
       - name: Upload Generated Files
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ matrix.api }}-examples-${{ matrix.page }}
           path: wasm-examples
@@ -67,7 +67,7 @@ jobs:
       steps:
 
         - name: Download all artifacts
-          uses: actions/download-artifact@v3
+          uses: actions/download-artifact@v4
 
         - name: Group examples in one folder
           run: |

.github/workflows/build-wasm-examples.yml

@@ -9,12 +9,88 @@ on:
       - 'trying'
 
 jobs:
+  markdownlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # Full git history is needed to get a proper list of changed files within `super-linter`
+          fetch-depth: 0
+      - name: Run Markdown Lint
+        uses: docker://ghcr.io/github/super-linter:slim-v4
+        env:
+          VALIDATE_ALL_CODEBASE: false
+          VALIDATE_MARKDOWN: true
+          DEFAULT_BRANCH: main
+
+  test-code-examples:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Install alsa and udev
+        run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev
+
+      - name: Build & run doc tests
+        run: cd code-validation && cargo test
+
+  check-hide-lines:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+      
+      - name: Check hide-lines
+        run: cd write-rustdoc-hide-lines && cargo run --release -- check ../content
+
+  lint-tools:
+    runs-on: ubuntu-latest
+    env:
+      TOOLS: |
+        code-validation generate-assets generate-community generate-errors generate-release write-rustdoc-hide-lines
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Install alsa and udev
+        run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev
+
+      - name: Check formatting
+        run: |
+          for CRATE in $TOOLS; do
+            cd $CRATE
+
+            echo Checking $CRATE
+            cargo fmt --check
+
+            cd ..
+          done
+
+      - name: Check clippy
+        run: |
+          for CRATE in $TOOLS; do
+            cd $CRATE
+
+            echo Checking $CRATE
+            cargo clippy -- -Dwarnings
+
+            cd ..
+          done
+
   generate-assets:
+    needs: [markdownlint, test-code-examples, lint-tools, check-hide-lines]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v4
 
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           path: |
             ~/.cargo/bin/
@@ -26,10 +102,10 @@ jobs:
 
       - name: Get cache key
         id: cache-key
-        run: echo "::set-output name=key::$(date +'%Y-%m-%d')"
+        run: echo "key=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
 
       - name: Get crates.io datadump from cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: generate-assets/data
           key: ${{ runner.os }}-${{ steps.cache-key.outputs.key }}
@@ -40,18 +116,19 @@ jobs:
           export GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }} &&
           ./generate_assets.sh
 
-      - uses: actions/upload-artifact@master
+      - uses: actions/upload-artifact@v4
         with:
           name: generated-assets
           path: content/assets
           retention-days: 1
 
   generate-errors:
+    needs: [markdownlint, test-code-examples, lint-tools, check-hide-lines]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v4
 
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           path: |
             ~/.cargo/bin/
@@ -66,24 +143,32 @@ jobs:
           cd generate-errors &&
           ./generate_errors.sh
 
-      - uses: actions/upload-artifact@master
+      - uses: actions/upload-artifact@v4
         with:
           name: generated-errors
           path: content/learn/errors
           retention-days: 1
 
   generate-wasm-examples:
+    needs: [markdownlint, test-code-examples, lint-tools, check-hide-lines]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v4
+
+      - name: "Clone Bevy"
+        run: >
+          cd generate-wasm-examples &&
+          ./clone_bevy.sh
 
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           path: |
             ~/.cargo/bin/
             ~/.cargo/registry/index/
             ~/.cargo/registry/cache/
             ~/.cargo/git/db/
+            generate-wasm-examples/bevy/target/
+            content/examples/**/*.wasm
           key: ${{ runner.os }}-generate-wasm-examples-${{ hashFiles('generate-wasm-examples/bevy/Cargo.toml') }}
 
       - uses: dtolnay/rust-toolchain@stable
@@ -95,24 +180,25 @@ jobs:
           cd generate-wasm-examples &&
           ./generate_wasm_examples.sh
 
-      - uses: actions/upload-artifact@master
+      - uses: actions/upload-artifact@v4
         with:
           name: generated-wasm-examples
           path: content/examples
           retention-days: 1
 
-      - uses: actions/upload-artifact@master
+      - uses: actions/upload-artifact@v4
         with:
           name: generated-wasm-examples-webgpu
           path: content/examples-webgpu
           retention-days: 1
 
   generate-community:
+    needs: [markdownlint, test-code-examples, lint-tools, check-hide-lines]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v4
 
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           path: |
             ~/.cargo/bin/
@@ -127,53 +213,39 @@ jobs:
           cd generate-community &&
           ./generate_community.sh
 
-      - uses: actions/upload-artifact@master
+      - uses: actions/upload-artifact@v4
         with:
           name: generated-community
           path: content/community/people
           retention-days: 1
 
-  markdownlint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          # Full git history is needed to get a proper list of changed files within `super-linter`
-          fetch-depth: 0
-      - name: Run Markdown Lint
-        uses: docker://ghcr.io/github/super-linter:slim-v4
-        env:
-          VALIDATE_ALL_CODEBASE: false
-          VALIDATE_MARKDOWN: true
-          DEFAULT_BRANCH: main
-
   build-website:
     runs-on: ubuntu-latest
-    needs: [markdownlint, generate-assets, generate-errors, generate-wasm-examples, generate-community]
+    needs: [markdownlint, test-code-examples, lint-tools, check-hide-lines, generate-assets, generate-errors, generate-wasm-examples, generate-community]
 
     steps:
-      - uses: actions/checkout@master
-      - uses: actions/download-artifact@master
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
         with:
           name: generated-assets
           path: content/assets
 
-      - uses: actions/download-artifact@master
+      - uses: actions/download-artifact@v4
         with:
           name: generated-errors
           path: content/learn/errors
 
-      - uses: actions/download-artifact@master
+      - uses: actions/download-artifact@v4
         with:
           name: generated-wasm-examples
           path: content/examples
 
-      - uses: actions/download-artifact@master
+      - uses: actions/download-artifact@v4
         with:
           name: generated-wasm-examples-webgpu
           path: content/examples-webgpu
 
-      - uses: actions/download-artifact@master
+      - uses: actions/download-artifact@v4
         with:
           name: generated-community
           path: content/community/people

.github/workflows/ci.yml

@@ -11,14 +11,14 @@ jobs:
   build_and_deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v4
 
       - name: Get current date
         id: date
-        run: echo "::set-output name=date::$(date +'%Y-%m-%d')"
+        run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
 
       - name: Cache multiple crates.io datadump
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: generate-assets/data
           key: ${{ runner.os }}-${{ steps.date.outputs.date }}