Merge pull request #22 from kurone-kito/cumulative-updates

v0.11.2: Some potential bug fixes

Author: kurone-kito

.github/CONTRIBUTING.md

@@ -8,10 +8,10 @@ Language: **🇬🇧** | [🇯🇵](./CONTRIBUTING.ja.md) | [🇨🇳](./CONTRIB
    follow it in all your interactions with the project.
 2. When contributing to this repository,
    please first discuss the change you wish to make via
-   [Issues](https://github.com/kurone-kito/udonsharp-toyboxs/issues) or any
+   [Issues](https://github.com/kurone-kito/udonsharp-toybox/issues) or any
    other method with the owners of this repository before making a change.
 3. If your idea can be shown **with a minor fix, please use directly the
-   [pull request](https://github.com/kurone-kito/udonsharp-toyboxs/pulls)**.
+   [pull request](https://github.com/kurone-kito/udonsharp-toybox/pulls)**.
    - This repository sometimes operates with a one-to-one tie between pull
      requests and releases, which is **not required**.  
      We welcome your pull requests.

.github/CONTRIBUTING.zh.md

@@ -6,6 +6,6 @@ Language: [🇬🇧](./CONTRIBUTING.md) | [🇯🇵](./CONTRIBUTING.ja.md) | **
 
 1. 请注意我们有[行为准则](./CODE_OF_CONDUCT.zh.md)，请在与项目的所有互动中遵循。
 2. 在为此存储库做出贡献时，请首先在进行更改之前与该存储库的所有者讨论您希望通过问题或任何其他方法进行的更改。
-3. 如果您的想法可以通过**小修复显示，请直接使用[拉取请求](https://github.com/kurone-kito/udonsharp-toyboxs/pulls)**。
+3. 如果您的想法可以通过**小修复显示，请直接使用[拉取请求](https://github.com/kurone-kito/udonsharp-toybox/pulls)**。
    - 本版本库有时会在拉取请求和发布之间建立一对一的绑定关系，但这并**不是必须的**。我们欢迎您的拉取请求。
 4. 在此存储库中，建议**使用[英语或日语](https://translate.google.com/)进行**讨论。

.github/dependabot.yml

@@ -4,9 +4,5 @@ updates:
     labels:
       - dependencies
     package-ecosystem: github-actions
-    reviewers:
-      - kurone-kito
-    assignees:
-      - kurone-kito
     schedule:
       interval: monthly

.github/workflows/build-listing.yml

@@ -1,9 +1,4 @@
 name: Build Repo Listing
-
-env:
-  listPublishDirectory: Website
-  pathToCi: ci
-
 on:
   release:
     types:
@@ -22,6 +17,7 @@ on:
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
+  actions: write
   contents: read
   id-token: write
   pages: write
@@ -32,44 +28,25 @@ concurrency:
   group: pages
 
 jobs:
-  build-listing:
+  website:
+    secrets: inherit
+    uses: ./.github/workflows/build-website.yml
+    with:
+      listPublishDirectory: Website
+      pathToCi: ci
+
+  deploy:
+    needs: website
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    name: build-listing
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout Local Repository
-        uses: actions/checkout@v4
-      - name: Checkout Automation Repository without removing prior checkouts
-        uses: actions/checkout@v4
-        with:
-          clean: false
-          path: ${{ env.pathToCi }}
-          repository: vrchat-community/package-list-action
-      - name: Deploy the global.json file
-        run: cp "${{ github.workspace }}/global.json" "${{ env.pathToCi }}/"
-      - name: Load cached data from previous runs
-        uses: actions/cache@v4
-        with:
-          key: ${{ runner.os }}-${{ hashFiles('**/global.json', '**/*.csproj') }}
-          path: |
-            ${{ env.pathToCi }}/.nuke/temp
-            ~/.nuget/packages
-      - name: Correct the documentation metadata
-        uses: nikeee/[email protected]
-        with:
-          args: metadata Documentation/docfx.json
-      - name: Build the documentation
-        uses: nikeee/[email protected]
+      - name: Download listing artifact
+        uses: actions/download-artifact@v4
         with:
-          args: build Documentation/docfx.json
-      - name: move the documentation to the publish directory
-        run: cp -r Documentation/_site ${{ env.listPublishDirectory }}/docs
-      - env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        name: Build Package Version Listing with Nuke
-        run: '"${{ env.pathToCi }}/build.cmd" BuildRepoListing --root "${{ env.pathToCi }}" --list-publish-directory "$GITHUB_WORKSPACE/${{ env.listPublishDirectory }}" --current-package-name "${{ vars.PACKAGE_NAME }}"'
+          name: listing-site
+          path: Website
       - name: Prepare for GitHub Pages deployment
         uses: actions/configure-pages@v5
         with:
@@ -78,7 +55,7 @@ jobs:
       - name: Upload the VPM Listing Website to GitHub Pages artifacts
         uses: actions/upload-pages-artifact@v3
         with:
-          path: ${{ env.listPublishDirectory }}
+          path: Website
       - id: deployment
         name: Deploy the uploaded VPM Listing Website to GitHub Pages
         uses: actions/deploy-pages@v4

.github/workflows/build-website.yml

@@ -0,0 +1,56 @@
+name: Build the website
+
+on:
+  workflow_call:
+    inputs:
+      listPublishDirectory:
+        required: true
+        type: string
+      pathToCi:
+        required: true
+        type: string
+      zipFile:
+        required: false
+        type: string
+        default: ''
+      unityPackage:
+        required: false
+        type: string
+        default: ''
+permissions:
+  actions: write
+  contents: read
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Local Repository
+        uses: actions/checkout@v4
+      - name: Checkout Automation Repository without removing prior checkouts
+        uses: actions/checkout@v4
+        with:
+          clean: false
+          path: ${{ inputs.pathToCi }}
+          repository: vrchat-community/package-list-action
+      - name: Deploy the global.json file
+        run: cp "${{ github.workspace }}/global.json" "${{ inputs.pathToCi }}/"
+      - name: Load cached data from previous runs
+        uses: actions/cache@v4
+        with:
+          key: ${{ runner.os }}-${{ hashFiles('**/global.json', '**/*.csproj') }}
+          path: |
+            ${{ inputs.pathToCi }}/.nuke/temp
+            ~/.nuget/packages
+          restore-keys: |
+            ${{ runner.os }}-
+      - env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        name: Build Package Version Listing with Nuke
+        run: '"${{ inputs.pathToCi }}/build.cmd" BuildRepoListing --root "${{ inputs.pathToCi }}" --list-publish-directory "$GITHUB_WORKSPACE/${{ inputs.listPublishDirectory }}" --current-package-name "${{ vars.PACKAGE_NAME }}"'
+      - name: Upload listing artifact
+        uses: actions/upload-artifact@v4
+        with:
+          if-no-files-found: error
+          name: listing-site
+          path: ${{ inputs.listPublishDirectory }}
+          retention-days: 1

.github/workflows/package-build.yml

@@ -0,0 +1,47 @@
+name: Build Package Artifacts
+
+on:
+  workflow_call:
+    inputs:
+      packagePath:
+        required: true
+        type: string
+      unityPackage:
+        required: true
+        type: string
+      zipFile:
+        required: true
+        type: string
+permissions:
+  actions: write
+  contents: read
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Local Repository
+        uses: actions/checkout@v4
+      - name: Zip the Package
+        run: zip -r -9 "${{ github.workspace }}/${{ inputs.zipFile }}" .
+        working-directory: "${{ inputs.packagePath }}"
+      - name: Build a list of .meta files for future use
+        run: find "${{ inputs.packagePath }}/" -name '*.meta' -type f >> metaList
+      - name: Make a UnityPackage version of the Package
+        uses: pCYSl5EDgo/[email protected]
+        with:
+          include-files: metaList
+          package-path: ${{ inputs.unityPackage }}
+      - name: Upload package archive
+        uses: actions/upload-artifact@v4
+        with:
+          if-no-files-found: error
+          name: ${{ inputs.zipFile }}
+          path: ${{ inputs.zipFile }}
+          retention-days: 1
+      - name: Upload UnityPackage
+        uses: actions/upload-artifact@v4
+        with:
+          if-no-files-found: error
+          name: ${{ inputs.unityPackage }}
+          path: ${{ inputs.unityPackage }}
+          retention-days: 1

.github/workflows/push.yml

@@ -1,49 +1,41 @@
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
 name: The CI workflow on push
 on:
   push:
     branches:
       - '*'
       - '!main'
-permissions:
-  contents: read
+  pull_request:
 jobs:
-  build:
-    env:
-      listPublishDirectory: Website
-      packagePath: Packages/${{ vars.PACKAGE_NAME }}
-      pathToCi: ci
-      unityPackage: ${{ vars.PACKAGE_NAME }}-feature.unitypackage
-      zipFile: ${{ vars.PACKAGE_NAME }}-feature.zip
+  lint:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Local Repository
         uses: actions/checkout@v4
-      - name: Zip the Package for testing
-        run: zip -r "${{ github.workspace }}/${{ env.zipFile }}" .
-        working-directory: "${{ env.packagePath }}"
-      - name: Build a list of .meta files for future use
-        run: find "${{ env.packagePath }}/" -name '*.meta' -type f >> metaList
-      - name: Make a UnityPackage version of the Package for release
-        uses: pCYSl5EDgo/create-unitypackage@v1
-        with:
-          include-files: metaList
-          package-path: ${{ env.unityPackage }}
-      - name: Checkout Automation Repository without removing prior checkouts
-        uses: actions/checkout@v4
-        with:
-          clean: false
-          path: ${{ env.pathToCi }}
-          repository: vrchat-community/package-list-action
-      - name: Deploy the global.json file
-        run: cp "${{ github.workspace }}/global.json" "${{ env.pathToCi }}/"
-      - name: Load cached data from previous runs
-        uses: actions/cache@v4
-        with:
-          key: ${{ runner.os }}-${{ hashFiles('**/global.json', '**/*.csproj') }}
-          path: |
-            ${{ env.pathToCi }}/.nuke/temp
-            ~/.nuget/packages
-      - env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        name: Build Package Version Listing with Nuke
-        run: '"${{ env.pathToCi }}/build.cmd" BuildRepoListing --root "${{ env.pathToCi }}" --list-publish-directory "$GITHUB_WORKSPACE/${{ env.listPublishDirectory }}" --current-package-name "${{ vars.PACKAGE_NAME }}"'
+      - name: Run cspell
+        uses: streetsidesoftware/cspell-action@v7
+      - name: Run markdownlint
+        uses: DavidAnson/markdownlint-cli2-action@v20
+  package:
+    permissions:
+      actions: write
+      contents: read
+    secrets: inherit
+    uses: ./.github/workflows/package-build.yml
+    with:
+      packagePath: Packages/${{ vars.PACKAGE_NAME }}
+      unityPackage: ${{ vars.PACKAGE_NAME }}-feature.unitypackage
+      zipFile: ${{ vars.PACKAGE_NAME }}-feature.zip
+  website:
+    needs: package
+    permissions:
+      actions: write
+      contents: read
+    uses: ./.github/workflows/build-website.yml
+    with:
+      listPublishDirectory: Website
+      pathToCi: ci
+      zipFile: ${{ vars.PACKAGE_NAME }}-feature.zip
+      unityPackage: ${{ vars.PACKAGE_NAME }}-feature.unitypackage