feat: consolidate simplification (#50)

BREAKING CHANGE: The 4.x update consolidates the changes in the 3.x and simplifies a few more steps of the usage experience. It completely removes the ISceneLoader implementations and adds a static MySceneManager class so you don't have to manually control its lifecycle. Refer to the upgrade guide at https://scene-loader.mygamedevtools.com/docs/upgrades/from-3-to-4 for more details.

Author: joaoborks

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,71 @@
+name: Bug Report
+description: Report a bug or unexpected behavior
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Bug Report
+        Please provide as much detail as possible to help us identify and fix the issue.
+  - type: input
+    id: summary
+    attributes:
+      label: Summary
+      description: A brief summary of the bug
+      placeholder: "Scene transition freezes..."
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to Reproduce
+      description: Steps to reproduce the issue
+      placeholder: |
+        1. Load scene A
+        2. Transition to scene B
+        3. Observe the freeze
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What did you expect to happen?
+    validations:
+      required: true
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Behavior
+      description: What actually happened?
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Package Version
+      description: The version of the package you are using
+      placeholder: "e.g., 3.1.0"
+    validations:
+      required: true
+  - type: input
+    id: editorversion
+    attributes:
+      label: Unity Editor Version
+      description: The version of the Unity Editor you are using
+      placeholder: "e.g., 6000.0.40f1"
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs
+      description: Please attach any relevant logs or errors
+      render: shell
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Acknowledgement
+      options:
+        - label: I have searched the existing issues to avoid duplicates
+          required: true

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,38 @@
+name: Feature Request
+description: Suggest an idea or enhancement
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Feature Request
+        Have a feature idea? Let us know what you'd like to see in My Scene Manager!
+  - type: input
+    id: summary
+    attributes:
+      label: Summary
+      description: A brief summary of the feature
+      placeholder: "Add support for async scene loading with progress callbacks"
+    validations:
+      required: true
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem or Use Case
+      description: What problem would this feature solve? How would it be useful?
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed Solution
+      description: Describe how you'd like the feature to work
+    validations:
+      required: true
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Acknowledgement
+      options:
+        - label: I have searched the existing issues to ensure this feature hasn't been requested already
+          required: true

.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,39 @@
+name: Question
+description: Ask a question or request help
+labels: ["question"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Question or Support Request
+        Need help or have a question about using My Scene Manager? Let us know!
+  - type: textarea
+    id: question
+    attributes:
+      label: Your Question
+      description: Clearly describe your question or the help you need
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Package Version
+      description: The version of the package you are using
+      placeholder: "e.g., 3.1.0"
+    validations:
+      required: true
+  - type: input
+    id: editorversion
+    attributes:
+      label: Unity Editor Version
+      description: The version of the Unity Editor you are using
+      placeholder: "e.g., 6000.0.40f1"
+    validations:
+      required: true
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Acknowledgement
+      options:
+        - label: I have searched the documentation and existing issues
+          required: true

.github/workflows/release-pre.yml

@@ -14,6 +14,5 @@ jobs:
     with:
       blockPullRequestRelease: false
       blockReleaseCommit: true
-    secrets:
-      githubToken: ${{ secrets.GH_TOKEN }}
+    secrets: inherit
 

.github/workflows/release-template.yml

@@ -13,7 +13,13 @@ on:
         required: false
         type: boolean
     secrets:
-      githubToken:
+      GH_TOKEN:
+        required: true
+      UNITY_LICENSE:
+        required: true
+      UNITY_EMAIL:
+        required: true
+      UNITY_PASSWORD:
         required: true
 
 jobs:
@@ -28,19 +34,22 @@ jobs:
       with:
         fetch-depth: 0
         persist-credentials: false
+
     # Removes the git plugin from semantic release so it doesn't generate a new commit
     - name: ✂️ Disable semantic release commit
       if: ${{ inputs.blockReleaseCommit == true }}
       run: |
         cat .releaserc.json | jq 'del(.plugins[] | select(type == "array" and .[0] == "@semantic-release/git"))' .releaserc.json > .releaserc.json.tmp && mv .releaserc.json.tmp .releaserc.json
+
     - name: 🚀 Semantic Release
       id: release
       uses: cycjimmy/semantic-release-action@v4
       with:
         dry_run: ${{ inputs.dryRun }}
         ci: ${{ inputs.blockPullRequestRelease }}
       env:
-        GH_TOKEN: ${{ secrets.githubToken }}
+        GH_TOKEN: ${{ secrets.GH_TOKEN }}
+
     - name: 📄 Summary
       run: |
         if [ '${{ steps.release.outputs.new_release_published }}' == 'true' ] && [ '${{ inputs.dryRun }}' == 'false' ]; then
@@ -60,32 +69,90 @@ jobs:
       uses: actions/checkout@v4
       with:
         fetch-depth: 0
+
     - name: 📤 Extract Path
       id: extract-path
       run: |
         PACKAGE_PATH=$(jq -r '.plugins[] | select(type == "array" and .[0] == "@semantic-release/npm") | .[1].pkgRoot' .releaserc.json)
         echo "PACKAGE_PATH=$PACKAGE_PATH" >> $GITHUB_ENV
+
     - name: ✏️ Update package.json
       run: |
         jq '.version = "${{ env.releaseVersion }}"' $PACKAGE_PATH/package.json > package.json.tmp && mv package.json.tmp $PACKAGE_PATH/package.json
+
     - name: 📦 Package UPM Branch
       id: package_upm
       run: |
         git config --global user.name 'semantic-release-bot'
         git config --global user.email '[email protected]'
-        git commit -am "update package.json"
+        git commit --amend -a --no-edit
         git branch -d upm &> /dev/null || echo upm branch not found
         git subtree split -P "$PACKAGE_PATH" -b upm
         git checkout upm
         if [[ -d "Samples" ]]; then
           git mv Samples Samples~
           rm -f Samples.meta
-          git commit -am "fix: Samples => Samples~"
+          git commit --amend -a --no-edit
         fi
         git push -f -u origin upm
+
     - name: 🏷️ Create UPM Tag
       run: |
         git tag $TAG upm
         git push origin --tags
       env:
-        TAG: upm/${{ env.releaseVersion }}
+        TAG: upm/${{ env.releaseVersion }}
+
+  export-unity-package:
+    runs-on: ubuntu-latest
+    needs: 'semantic-release'
+    if: ${{ needs.semantic-release.outputs.new_release_published == 'true' && inputs.dryRun == false }}
+    env:
+      releaseVersion: ${{ needs.semantic-release.outputs.new_release_version }}
+    steps:
+    - name: 📂 Checkout
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: 📤 Extract Path
+      id: extract-path
+      run: |
+        PACKAGE_PATH=$(jq -r '.plugins[] | select(type == "array" and .[0] == "@semantic-release/npm") | .[1].pkgRoot' .releaserc.json)
+        echo "PACKAGE_PATH=$PACKAGE_PATH" >> $GITHUB_ENV
+        
+    - name: ✏️ Update package.json
+      run: |
+        jq '.version = "${{ env.releaseVersion }}"' $PACKAGE_PATH/package.json > package.json.tmp && mv package.json.tmp $PACKAGE_PATH/package.json
+
+    - name: 🔄 Rename Samples Folder
+      run: |
+        if [[ -d "$PACKAGE_PATH/Samples" ]]; then
+          mv "$PACKAGE_PATH/Samples" "$PACKAGE_PATH/Samples~"
+          rm -f "$PACKAGE_PATH/Samples.meta"
+        fi
+
+    - name: 🗃️ Cache Library
+      uses: actions/cache@v4
+      with:
+        path: Library
+        key: Library-StandaloneLinux64
+        restore-keys: Library-
+
+    - name: 📦 Export Unity Package
+      uses: game-ci/unity-builder@v4
+      with:
+        targetPlatform: StandaloneLinux64
+        buildMethod: PackageExporter.ExportPackage
+        projectPath: "."
+        allowDirtyBuild: true
+      env:
+        UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
+        UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
+        UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
+
+    - name: 🗂️ Upload Unity Package Artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: com.mygamedevtools.scene-loader-${{ env.releaseVersion }}
+        path: "./*.unitypackage"

.github/workflows/release.yml

@@ -10,5 +10,4 @@ jobs:
   create-release:
     name: Release
     uses: ./.github/workflows/release-template.yml
-    secrets:
-      githubToken: ${{ secrets.GH_TOKEN }}
+    secrets: inherit

.gitignore

@@ -78,4 +78,8 @@ crashlytics-build.properties
 
 # Temporary auto-generated Android Assets
 [Aa]ssets/[Ss]treamingAssets/aa.meta
-[Aa]ssets/[Ss]treamingAssets/aa/*
+[Aa]ssets/[Ss]treamingAssets/aa/*
+
+# Website
+.docusaurus
+node_modules/