Sync new book to main

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

@@ -0,0 +1,86 @@
+name: Build WASM Examples
+
+on:
+  workflow_dispatch:
+
+env:
+  PER_PAGE: 50
+
+jobs:
+  wasm-examples:
+    name: Build WASM Examples
+    runs-on: macos-latest
+    strategy:
+      matrix:
+        # if all examples are not built, add a new page here
+        page: [0, 1, 2]
+        api: [webgl2, webgpu]
+    steps:
+
+      - name: Checkout Bevy latest tag
+        uses: actions/checkout@master
+        with:
+          repository: 'bevyengine/bevy'
+          ref: 'latest'
+
+      # temporary: fetch tools from main branch
+      - name: Checkout Bevy Tools
+        uses: actions/checkout@master
+        with:
+          repository: 'bevyengine/bevy'
+          ref: 'main'
+          path: 'bevy-tools'
+      - name: Copy Bevy tools to latest
+        run: |
+          cp -r bevy-tools/tools/ tools
+          rm -rf bevy-tools
+
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          target: wasm32-unknown-unknown,x86_64-apple-darwin
+
+      - name: Install WASM tooling
+        run: |
+          cargo install --force wasm-bindgen-cli
+          mkdir ./binaryen
+          wget -qO- https://github.com/WebAssembly/binaryen/releases/download/version_114/binaryen-version_114-x86_64-macos.tar.gz | tar xvz --strip-components 1 -C ./binaryen binaryen-version_114
+
+      - name: Build WASM Examples
+        run: |
+          export PATH=$PATH:`pwd`/binaryen/bin
+          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
+        with:
+          name: ${{ matrix.api }}-examples-${{ matrix.page }}
+          path: wasm-examples
+
+  cloudflare-upload:
+      name: Upload to Cloudflare
+      runs-on: ubuntu-latest
+      needs: wasm-examples
+      strategy:
+        matrix:
+          api: [webgl2, webgpu]  
+      steps:
+
+        - name: Download all artifacts
+          uses: actions/download-artifact@v3
+
+        - name: Group examples in one folder
+          run: |
+            mkdir ${{ matrix.api }}
+            for file in ${{ matrix.api }}-examples-*
+            do
+              rsync -a $file/* ${{ matrix.api }}/
+            done
+
+        - name: Publish to Cloudflare Pages
+          uses: cloudflare/pages-action@v1
+          with:
+            apiToken: ${{ secrets.CLOUDFLARE_PAGES }}
+            accountId: 0e862a54d5c283c78d8d56adb6159df8
+            projectName: bevy-${{ matrix.api }}-examples
+            directory: ${{ matrix.api }}

.github/workflows/ci.yml

@@ -2,6 +2,7 @@ name: CI
 
 on:
   pull_request:
+  merge_group:
   push:
     branches:
       - 'staging'
@@ -95,14 +96,12 @@ jobs:
             content/examples/**/*.wasm
           key: ${{ runner.os }}-generate-wasm-examples-${{ hashFiles('generate-wasm-examples/bevy/Cargo.toml') }}
 
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: stable
           target: wasm32-unknown-unknown
 
       - name: "Build Bevy Examples"
-        run: >
-          cargo install --force wasm-bindgen-cli &&
+        run: |
           cd generate-wasm-examples &&
           ./generate_wasm_examples.sh
 
@@ -112,6 +111,12 @@ jobs:
           path: content/examples
           retention-days: 1
 
+      - uses: actions/upload-artifact@master
+        with:
+          name: generated-wasm-examples-webgpu
+          path: content/examples-webgpu
+          retention-days: 1
+
   generate-community:
     needs: [markdownlint, test-code]
     runs-on: ubuntu-latest
@@ -142,7 +147,7 @@ jobs:
   markdownlint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v2
         with:
           # Full git history is needed to get a proper list of changed files within `super-linter`
           fetch-depth: 0
@@ -151,7 +156,7 @@ jobs:
         env:
           VALIDATE_ALL_CODEBASE: false
           VALIDATE_MARKDOWN: true
-          DEFAULT_BRANCH: master
+          DEFAULT_BRANCH: main
 
   test-code:
     runs-on: ubuntu-latest
@@ -172,7 +177,7 @@ jobs:
 
   build-website:
     runs-on: ubuntu-latest
-    needs: [generate-assets, generate-errors, generate-wasm-examples, generate-community]
+    needs: [markdownlint, generate-assets, generate-errors, generate-wasm-examples, generate-community]
 
     steps:
       - uses: actions/checkout@master
@@ -191,13 +196,18 @@ jobs:
           name: generated-wasm-examples
           path: content/examples
 
+      - uses: actions/download-artifact@master
+        with:
+          name: generated-wasm-examples-webgpu
+          path: content/examples-webgpu
+
       - uses: actions/download-artifact@master
         with:
           name: generated-community
           path: content/community/people
 
       - name: "Build website"
-        uses: shalzz/zola-deploy-action@master
+        uses: shalzz/zola-deploy-action@v0.16.1-1
         env:
           PAGES_BRANCH: gh-pages
           BUILD_DIR: .

.github/workflows/deploy.yml

@@ -2,7 +2,7 @@ name: Deploy
 
 on:
   push:
-    branches: [master]
+    branches: [main]
   schedule:
     - cron:  '0 0 * * *'
   workflow_dispatch:
@@ -34,17 +34,16 @@ jobs:
       - name: "Build Bevy Community"
         run: cd generate-community && ./generate_community.sh
 
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: stable
           target: wasm32-unknown-unknown
 
       - name: "Build Bevy Examples"
-        run: cargo install wasm-bindgen-cli && cd generate-wasm-examples && ./generate_wasm_examples.sh
+        run: cd generate-wasm-examples && ./generate_wasm_examples.sh
 
       - name: "Build and deploy website"
         if: github.repository_owner == 'bevyengine'
-        uses: shalzz/zola-deploy-action@master
+        uses: shalzz/zola-deploy-action@v0.16.1-1
         env:
           PAGES_BRANCH: gh-pages
           BUILD_DIR: .

.github/workflows/update-screenshots.yml

@@ -0,0 +1,97 @@
+name: Update Screenshots
+
+on:
+  workflow_dispatch:
+
+env:
+  PER_PAGE: 20
+
+jobs:
+  take-screenshots:
+    name: Take Screenshots
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # if all examples are not built, add a new page here
+        page: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
+    steps:
+
+      - name: Checkout Bevy latest tag
+        uses: actions/checkout@master
+        with:
+          repository: 'bevyengine/bevy'
+          ref: 'latest'
+
+      # temporary: fetch tools from main branch
+      - name: Checkout Bevy Tools
+        uses: actions/checkout@master
+        with:
+          repository: 'bevyengine/bevy'
+          ref: 'main'
+          path: 'bevy-tools'
+      - name: Copy Bevy tools to latest
+        run: |
+          rm -rf tools
+          cp -r bevy-tools/tools/ tools
+          rm -rf bevy-tools
+
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Install Bevy dependencies
+        run: |
+          sudo apt-get update;
+          DEBIAN_FRONTEND=noninteractive sudo apt-get install --no-install-recommends -yq \
+            libasound2-dev libudev-dev;
+
+      - name: install xvfb, llvmpipe and lavapipe
+        run: |
+          sudo apt-get update -y -qq
+          sudo add-apt-repository ppa:oibaf/graphics-drivers -y
+          sudo apt-get update
+          sudo apt install -y xvfb libegl1-mesa libgl1-mesa-dri libxcb-xfixes0-dev mesa-vulkan-drivers
+
+      - name: Take Screenshots
+        run: |
+          xvfb-run cargo run -p example-showcase -- --page ${{ matrix.page }} --per-page ${{ env.PER_PAGE }} run --screenshot --in-ci
+
+      - name: Upload Generated Files
+        uses: actions/upload-artifact@v3
+        with:
+          name: screenshots-${{ matrix.page }}
+          path: screenshots
+
+  prepare-pr:
+    name: Prepare Screenshots Update PR
+    runs-on: ubuntu-latest
+    needs: take-screenshots
+    permissions:
+      pull-requests: write
+      contents: write
+    steps:
+
+      - name: Clone bevy-website repo
+        uses: actions/checkout@master
+
+      - name: Download all artifacts
+        uses: actions/download-artifact@v3
+
+      - name: Move examples to the correct folder
+        run: |
+          rm -rf static/screenshots
+          mkdir static/screenshots
+          for file in screenshots-*
+          do
+            rsync -a $file/* static/screenshots/
+            rm -rf $file
+          done
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v5
+        with:
+          delete-branch: true
+          branch-suffix: random
+          title: Update Examples Screenshots
+          body: |
+            This PR updates the screenshots of the examples with latest version from Bevy.
+            It was automatically generated by a GitHub Action.

.gitignore

@@ -4,7 +4,9 @@ public
 content/assets
 content/learn/errors
 content/examples
+content/examples-webgpu
 content/community/people
+content/community/donate
 static/assets/examples
 static/processed_images
 .vscode/

code-validation/src/lib.rs

@@ -4,6 +4,11 @@
 //! The modules represents the folder structure of the website.
 
 mod learn {
+    #[doc = include_str!("../../content/learn/quick-start/_index.md")]
+    mod quick_start {
+        #[doc = include_str!("../../content/learn/quick-start/next-steps/_index.md")]
+        mod next_steps {}
+    }
     #[doc = include_str!("../../content/learn/book/_index.md")]
     mod book {
         #[doc = include_str!("../../content/learn/book/assets/_index.md")]
@@ -126,9 +131,6 @@ mod learn {
         // Not testing migration guides, because of breaking api changes.
         mod migration_guides {}
 
-        #[doc = include_str!("../../content/learn/book/next-steps/_index.md")]
-        mod next_steps {}
-
         #[doc = include_str!("../../content/learn/book/performance-optimizations/_index.md")]
         mod performance_optimizations {
             #[doc = include_str!("../../content/learn/book/performance-optimizations/component-storage/_index.md")]

content/community/_index.md

@@ -1,5 +1,5 @@
 +++
-title = "Community"
+title = "Bevy Community"
 template = "community.html"
 [extra]
 header_message = "Community"