merged changes

Author: pro470

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,17 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ":bug: {insert concise and search friendly title}"
+labels: bug
+assignees: ''
+
+---
+
+## Summary
+**summarise what problem you found and why it's a bug**
+
+## Reproducing
+**add any information that will help with reproducing the bug**
+
+## Additional Data
+**insert screenshots, bms + bevy trace/debug logs if possible**

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/request-new-language.md

@@ -0,0 +1,14 @@
+---
+name: Request New Language
+about: Request support for an additional language
+title: ":sparkles: Support `{enter language name}`"
+labels: language request
+assignees: ''
+
+---
+
+## Summary
+**name the language, describe it, provide links to it, explain why it'd be beneficial for consumers of this crate**
+
+## Feasibilty
+**explain how the language fulfils the feasibility criteria over at: https://makspll.github.io/bevy_mod_scripting/Development/AddingLanguages/evaluating-feasibility.html**

.github/pull_request_template.md

@@ -0,0 +1,25 @@
+# Summary
+- enter PR summary here
+- what did you change
+- why did you do it this way?
+- Are there alternative ways we need to keep in mind?
+
+## Testing (Read & Delete Me)
+- Did you write tests to cover new or modified behavior?
+- These are not necessary, but very welcome
+- I am always happy to receive any PR's, but adding tests makes it easier for me to merge them!
+
+## Conventional PR Titles (Read & Delete me)
+- This crate uses `release-plz` to manage our deploys
+- A CI check will verify your PR title to make sure it uses a valid conventional prefix like:
+    - `feat: {title}` - corresponds to `Added` heading in changelog, backwards compatibile changes
+    - `fix: {title}` - corresponds to `Fixed` heading in changelog, fixes bugs or bad behavior
+    - `chore: {title}` - does not appear in the changelog, useful for "meta" work that doesn't affect the API
+    - `docs: {title}` - does not appear in the changelog, for docuemntation changes.
+    - `tests: {title}` - does not appear in changelog, purely adds or changes tests.
+- Adding a `!` before the `:` will signify this is also a breaking change
+    - This sort of change will cause a `MAJOR` version bump.
+- You can also use scopes to further detail the area your PR is changing i.e.:
+    - `feat(ladfile): add global types`
+    - `fix(ladfile_builder): fix globals not getting exported`
+    - `docs(bms): document weird vector behavior on MacOS`

.github/workflows/bevy_mod_scripting.yml

@@ -3,15 +3,9 @@ on:
     branches:
       - main
       - staging
-    paths-ignore:
-      - '.github/workflows/release-plz.yml'
-      - 'docs/**'
   pull_request:
     branches:
       - "**"
-    paths-ignore:
-      - '.github/workflows/release-plz.yml'
-      - 'docs/**'
 
 
 name: CI
@@ -31,6 +25,31 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+
+  check-needs-run:
+    runs-on: ubuntu-latest
+    outputs:
+      any-changes: ${{ steps.changes.outputs.src }}
+    permissions:
+      pull-requests: read
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - uses: dorny/paths-filter@v3
+        id: changes
+        with:
+          base: main
+          filters: |
+            src:
+              - 'src/**'
+              - 'crates/**'
+              - 'examples/**'
+              - 'assets/**'
+              - 'docs/**'
+              - '.github/workflows/bevy_mod_scripting.yml'
+
+
   generate-job-matrix:
     runs-on: ubuntu-latest
     # container: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
@@ -39,6 +58,12 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+      - name: Rust Cache
+        uses: Swatinem/[email protected]
+        with:
+          # reasoning: we want to cache xtask, most of the jobs in the matrix will be sped up a good bit thanks to that 
+          save-if: ${{ github.ref == 'refs/heads/main' }}
+          cache-all-crates: true
       - name: Generate matrix
         id: generate-matrix
         run: |
@@ -49,52 +74,75 @@ jobs:
           echo "matrix=$(cat matrix-one-line.json)" >> $GITHUB_OUTPUT
 
   check:  
+    needs: [check-needs-run, generate-job-matrix]
     permissions:
       pull-requests: write
       contents: write
       issues: write
     name: Check - ${{ matrix.run_args.name }}
     runs-on: ${{ matrix.run_args.os }}
-    # container: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
-    needs: 
-      - generate-job-matrix
     strategy:
       matrix:
        run_args: ${{fromJson(needs.generate-job-matrix.outputs.matrix)}}
     steps:
+      # - name: Free Disk Space (Ubuntu)
+      #   if: runner.os == 'Linux'
+      #   uses: jlumbroso/free-disk-space@main
+      #   with:
+      #     tool-cache: false
+      #     android: true
+      #     dotnet: true
+      #     haskell: true
+      #     large-packages: true
+      #     docker-images: true
+      #     swap-storage: true
+      # # - if: runner.os == 'linux'
+      # #   run: |
+      # #     sudo rm -rf /usr/share/dotnet; sudo rm -rf /opt/ghc; sudo rm -rf "/usr/local/share/boost"; sudo rm -rf "$AGENT_TOOLSDIRECTORY"
       - name: Checkout
+        if: ${{ needs.check-needs-run.outputs.any-changes == 'true' }}
         uses: actions/checkout@v4
-
-      - name: Install alsa and udev
-        if: runner.os == 'linux'
-        run: |
-          sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev
-          sudo rm -rf /usr/share/dotnet; sudo rm -rf /opt/ghc; sudo rm -rf "/usr/local/share/boost"; sudo rm -rf "$AGENT_TOOLSDIRECTORY"
       - uses: actions-rs/toolchain@v1
+        if: ${{ needs.check-needs-run.outputs.any-changes == 'true' }}
         with:
           toolchain: stable
           override: true
-
       - name: Rust Cache
-        uses: Swatinem/[email protected]
+        if: ${{ needs.check-needs-run.outputs.any-changes == 'true' }}
+        uses: Swatinem/[email protected]
+        with:
+          # reasoning: we want to cache xtask, most of the jobs in the matrix will be sped up a good bit thanks to that 
+          save-if: ${{ github.ref == 'refs/heads/main' }}
+          cache-all-crates: true
 
       - name: Setup
+        if: ${{ needs.check-needs-run.outputs.any-changes == 'true' }}
         run: |
           cargo xtask init
 
+      - name: Setup GPU Drivers
+        if: ${{ needs.check-needs-run.outputs.any-changes == 'true' && matrix.run_args.requires_gpu }}
+        run: |
+          sudo add-apt-repository ppa:kisak/turtle -y
+          sudo apt-get install --no-install-recommends libxkbcommon-x11-0 xvfb libgl1-mesa-dri libxcb-xfixes0-dev mesa-vulkan-drivers
       - name: Check
+        if: ${{ needs.check-needs-run.outputs.any-changes == 'true' && !matrix.run_args.requires_gpu }}
         run: |
           ${{ matrix.run_args.command }}
+      - name: Check With virtual X11 server
+        if: ${{ needs.check-needs-run.outputs.any-changes == 'true' && matrix.run_args.requires_gpu }}
+        run: |
+          xvfb-run ${{ matrix.run_args.command }}
 
       - name: Upload coverage artifact
-        if: ${{ matrix.run_args.generates_coverage }}
+        if: ${{ needs.check-needs-run.outputs.any-changes == 'true' && matrix.run_args.generates_coverage }}
         uses: actions/upload-artifact@v4
         with:
           name: code-coverage-report
           path: target/coverage/html/
 
       - name: Update coverage badge
-        if: ${{ matrix.run_args.generates_coverage }}
+        if: ${{ needs.check-needs-run.outputs.any-changes == 'true' && matrix.run_args.generates_coverage }}
         continue-on-error: true
         run: |
           git checkout -b chore/_update-coverage-badge || git checkout chore/_update-coverage-badge
@@ -122,6 +170,15 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v4
+      with:
+        ref: ${{ github.head_ref || github.ref_name }}
+    - name: Rust Cache
+      if: ${{ needs.check-needs-run.outputs.any-changes == 'true' }}
+      uses: Swatinem/[email protected]
+      with:
+        # reasoning: we want to cache xtask, most of the jobs in the matrix will be sped up a good bit thanks to that 
+        save-if: ${{ github.ref == 'refs/heads/main' }}
+        cache-all-crates: true
     - name: Setup Bot GitHub Credentials
       run: |
         git config user.name "github-actions[bot]"
@@ -141,19 +198,6 @@ jobs:
     - name: Commit Changes
       if: steps.check_changes.outputs.changes
       run: |
-        git checkout -b ${{ env.CODEGEN_BRANCH_NAME }} || git checkout ${{ env.CODEGEN_BRANCH_NAME }}
         git add -A
         git commit -m "chore(codegen): update bevy bindings"
-        git push -u origin ${{ env.CODEGEN_BRANCH_NAME }} --force
-    - uses: jwalton/gh-find-current-pr@master
-      if: steps.check_changes.outputs.changes
-      id: findPR
-      with:
-        state: all
-    - name: Create Or Update PR
-      if: steps.check_changes.outputs.changes && success() && steps.findPR.outputs.number 
-      run: |
-        gh pr list --base ${{ github.ref }} --search "chore(codegen): update bevy bindings" --json number > prs.json
-        if [ $(jq '. | length' prs.json) -eq 0 ]; then
-          gh pr create --title "chore(codegen): update bevy bindings" --body "This PR updates the bevy bindings for #${{ steps.findPR.outputs.number }}" --base ${{ github.ref }} --head ${{ env.CODEGEN_BRANCH_NAME }} || true
-        fi
+        git push

.github/workflows/mdbook.yml

@@ -7,12 +7,14 @@ on:
       - staging
     paths:
       - 'docs/**'
+      - 'crates/xtask/**'
       - '.github/workflows/mdbook.yml'
   pull_request:
     branches:
       - "**"
     paths:
       - 'docs/**'
+      - 'crates/xtask/**'
       - '.github/workflows/mdbook.yml'
 
 jobs:
@@ -35,11 +37,14 @@ jobs:
     - name: Rust Cache
       uses: Swatinem/[email protected]
 
-    - name: Install mdBook
-      run: cargo install mdbook
+    - name: Setup xtask & GPU drivers
+      run: |
+        cargo xtask init --dont-update-ide
+        sudo add-apt-repository ppa:kisak/turtle -y
+        sudo apt-get install --no-install-recommends libxkbcommon-x11-0 xvfb libgl1-mesa-dri libxcb-xfixes0-dev mesa-vulkan-drivers
 
     - name: Build the book
-      run: cd docs && mdbook build
+      run: xvfb-run cargo xtask docs --no-rust-docs
 
     - name: Deploy to GitHub Pages
       if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/staging'

.github/workflows/missing-documentation-reminder.yml

@@ -0,0 +1,57 @@
+name: Missing Documentation Reminder
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+jobs:
+  find-missing-documentation:
+    permissions:
+      contents: read
+      pull-requests: read
+      issues: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Find closed PRs with 'needs documentation' label
+        uses: actions/github-script@v6
+        id: find-prs
+        with:
+          script: |
+
+            const query = `repo:makspll/bevy_mod_scripting is:closed label:"needs documentation"`;
+            const encodedQuery = encodeURIComponent(query);
+
+            console.log(encodedQuery);
+
+            const { data: { items: pullRequests } } = await github.rest.search.issuesAndPullRequests({
+              q: query,
+              per_page: 100
+            });
+
+            console.log(pullRequests)
+
+            const prsNeedingDocs = pullRequests.map(pr => `- [ ] ${pr.html_url} by @${pr.user.login}`).join("\n");
+            if (!prsNeedingDocs) {
+              return "- [x] All PRs with 'needs documentation' label have been updated in the book.";
+            } else {
+              return prsNeedingDocs;
+            }
+          result-encoding: string
+          
+      - name: Update Issue Body
+        uses: julien-deramond/update-issue-body@v1
+        with:
+          issue-number: 255
+          body: |
+            This is an automatically generated issue.
+            
+            The following PRs have been closed but still need updates in the book:
+            ${{ steps.find-prs.outputs.result }}
+
+            If you are an author of one of these PRs, please consider updating the boook in `/docs` with appropriate documentation.
+            Thank you!
+          edit-mode: replace

.github/workflows/pr-titles.yml

@@ -25,4 +25,10 @@ jobs:
             feat
             chore
             test
-            docs
+            docs
+            refactor
+
+          scopes: |
+            ladfile
+            ladfile_builder
+            bms

.github/workflows/release-plz.yml

@@ -66,4 +66,5 @@ jobs:
           command: release-pr
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+          RELEASE_PLZ_LOG: DEBUG

.gitignore

@@ -13,4 +13,8 @@ Cargo.lock
 **/doc
 assets/scripts/tlconfig.lua
 **.log
-**build/
+**build/
+.html
+
+/assets/**/*.lad.json
+/docs/src/ladfiles/*.lad.json