0.2.0

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: ci 
+on:
+  push:
+    branches:
+      - master 
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

.github/workflows/event.yml

@@ -1,8 +1,6 @@
 name: Event
 
 on:
-  pull_request:
-    types: [opened]
   issues:
     types: [opened]
 
@@ -22,12 +20,7 @@ jobs:
           WEBHOOK_URL: ${{ secrets.EVENT_WEBHOOK_URL }}
         run: |
           PROJECT="${{ github.repository }}"
-          if [ "${{ github.event_name }}" == "issues" ]; then
-            EVENT_URL="${{ github.event.issue.html_url }}"
-            EVENT_TITLE="${{ github.event.issue.title }}"
-          elif [ "${{ github.event_name }}" == "pull_request" ]; then
-            EVENT_URL="${{ github.event.pull_request.html_url }}"
-            EVENT_TITLE="${{ github.event.pull_request.title }}"
-          fi
+          EVENT_URL="${{ github.event.issue.html_url }}"
+          EVENT_TITLE="${{ github.event.issue.title }}"
 
-          lune run .lune/discord.luau "$WEBHOOK_URL" "event" "$PROJECT" "$EVENT_TITLE" "$EVENT_URL"
+          lune run .lune/discord.luau "$WEBHOOK_URL" "event" "$PROJECT" "$EVENT_TITLE" "$EVENT_URL"

.github/workflows/draft.yml → .github/workflows/release.yml

@@ -6,7 +6,9 @@ on:
       - 'v*.*.*'
 
 permissions:
-  contents: write
+    contents: write
+    pages: write
+    id-token: write
 
 jobs:
     bump:
@@ -46,8 +48,8 @@ jobs:
               git tag -f ${{ github.ref_name }}
               git push -f --tags
 
-    draft-build:
-        name: Draft & Build Assets
+    publish-build:
+        name: Publish Assets
         runs-on: ubuntu-latest
         needs: bump
         steps:
@@ -63,7 +65,7 @@ jobs:
           - name: Generate sourcemap
             run: argon sourcemap standalone.project.json --output sourcemap.json
 
-          - name: Generate Wally types
+          - name: Generate package types
             run: wally-package-types --sourcemap sourcemap.json Packages
 
           - name: Format code
@@ -77,10 +79,50 @@ jobs:
             with:
               tag_name: ${{ github.ref_name }}
               name: ${{ github.ref_name }}
-              draft: true
               prerelease: ${{ contains(github.ref_name, 'rc') }}
               body: |
                 ## Changelog
                 ${{ needs.bump.outputs.release-body }}
               files: |
-                ./Standalone.rbxm
+                ./Standalone.rbxm
+
+    publish-package:
+        name: Publish Package
+        runs-on: ubuntu-latest
+        needs: bump
+        steps:
+        - name: Checkout repository
+          uses: actions/checkout@v4
+
+        - name: Setup Rokit
+          uses: CompeyDev/[email protected]
+
+        - name: Log In
+          env:
+            WALLY_AUTH: ${{ secrets.WALLY_AUTH_TOKEN }}
+          run: |
+            mkdir ~/.wally
+            printenv WALLY_AUTH > ~/.wally/auth.toml
+
+        - name: Publish
+          run: |
+            wally publish
+
+    publish-announcement:
+        name: Publish Announcement
+        runs-on: ubuntu-latest
+        needs: [publish-package, publish-build]
+        steps:
+        - name: Checkout repository
+          uses: actions/checkout@v4
+
+        - name: Setup Rokit
+          uses: CompeyDev/[email protected]
+
+        - name: Send webhook
+          env:
+            WEBHOOK_URL: ${{ secrets.UPDATE_WEBHOOK_URL }}
+          run: |
+            PROJECT="${{ github.repository }}"
+            VERSION="${{ github.ref_name }}"
+            lune run .lune/discord.luau "$WEBHOOK_URL" "announcement" "$PROJECT" "$VERSION"

.gitignore

@@ -1,14 +1,10 @@
-# Vitepress
-docs/.vitepress/cache
-docs/.vitepress/dist
-
-# Node
-node_modules
+# Mkdocs
+venv
 
 # Wally
 Packages
 DevPackages
 wally.lock
 
 # Argon
-sourcemap.json
+sourcemap.json

.lune/discord.luau

@@ -2,13 +2,15 @@ local net = require("@lune/net")
 local process = require("@lune/process")
 
 local projectRole = "1277040514205614141"
-local projectMainterRole = "1277040552012943411"
 
 local webhook_url = process.args[1]
 local type = process.args[2]
 local project = process.args[3]
 
 local projectName = string.split(project, "/")[2]
+local formattedProjectName = string.gsub(projectName, "^%a", function(match)
+    return string.upper(match)
+end)
 
 if type == "announcement" then
 	local tag = process.args[4]
@@ -21,9 +23,9 @@ if type == "announcement" then
 			content = if noPing == true then nil else `<@&{projectRole}>`,
 			embeds = {
 				{
-					title = `Release {tag} · lumin-dev/{projectName}`,
-					description = `Release notification for the latest version of {projectName}`,
-					url = `https://github.com/lumin-dev/{projectName}/releases/tag/{tag}`,
+					title = `Release {tag} · {formattedProjectName}`,
+					description = `Release notification for the latest version of {formattedProjectName}`,
+					url = `https://github.com/luminlabsdev/{projectName}/releases/tag/{tag}`,
 					color = 7506646,
 					author = {
 						name = "GitHub",
@@ -43,18 +45,17 @@ elseif type == "event" then
 		method = "POST",
 		headers = { ["Content-Type"] = "application/json" },
 		body = net.jsonEncode({
-			content = `<@&{projectMainterRole}>`,
 			embeds = {
 				{
 					title = title,
-					description = `[View issue/pull request]({url})`,
+					description = `[View issue]({url})`,
 					color = 7506646,
 				},
 			},
-			thread_name = `{projectName} - {title}`,
+			thread_name = `{formattedProjectName} - {title}`,
 		}),
 	})
 	if not response.ok then
 		error(`{response.statusCode}:{response.statusMessage}`)
 	end
-end
+end

README.md

@@ -1,7 +1,7 @@
-<div align="center">
+# Plugin Framework
 
-# Lumin Plugin Framework
+[![license](https://img.shields.io/github/license/luminlabsdev/plugin-framework)](https://github.com/luminlabsdev/plugin-framework/blob/main/LICENSE)
+[![release](https://img.shields.io/github/v/release/luminlabsdev/plugin-framework)](https://github.com/luminlabsdev/plugin-framework/releases/latest)
+[![discord](https://img.shields.io/discord/1105688855375511642?logo=discord&logoColor=white&label=discord&color=4d3dff)](https://luminlabsdev.github.io/link/discord)
 
 An extension of Lumin Framework with added plugin support and methods.
-
-</div>

default.project.json

@@ -1,6 +1,6 @@
 {
-	"name": "PluginFramework",
+	"name": "framework",
 	"tree": {
 		"$path": "src"
 	}
-}
+}

dev.project.json

@@ -1,12 +1,12 @@
 {
 	"legacyScripts": true,
-	"name": "PluginFramework",
+	"name": "framework",
 	"tree": {
 		"$className": "DataModel",
 		"ReplicatedStorage": {
 			"Plugin": {
 				"$path": "Packages",
-				"plugin_framework": {
+				"framework": {
 					"$path": "src"
 				},
 				"Test": {
@@ -15,4 +15,4 @@
 			}
 		}
 	}
-}
+}

src/init.luau

@@ -15,10 +15,11 @@ local Menu = require(Library.Menu)
 
 return {
 	Start = Lumin.Start,
-	Controller = Lumin.Controller,
-	Expect = Lumin.Expect,
+    OnStart = Lumin.OnStart,
+	New = Lumin.New,
 	Worker = Lumin.Worker,
-	Signal = Lumin.Signal,
+    Load = Lumin.Load,
+    version = "0.2.0",
 
 	Unloading = plugin.Unloading,
 

standalone.project.json

@@ -2,8 +2,8 @@
     "name": "standalone",
     "tree": {
         "$path": "Packages",
-        "PluginFramework": {
+        "framework": {
             "$path": "src"
         }
     }
-}
+}