Skip to content

Commit

Permalink
chore: update repo to new standards
Browse files Browse the repository at this point in the history
updates the framework repo to newer standards, which make things more clear and organized
  • Loading branch information
2jammers committed Dec 16, 2024
1 parent e25b343 commit 93a7053
Show file tree
Hide file tree
Showing 14 changed files with 130 additions and 238 deletions.
29 changes: 0 additions & 29 deletions .github/workflows/ci.yml

This file was deleted.

81 changes: 35 additions & 46 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Draft
name: Release

on:
push:
Expand All @@ -11,88 +11,77 @@ permissions:
id-token: write

jobs:
bump:
name: Bump Versions
changelog:
name: Changelog
runs-on: ubuntu-latest
outputs:
release-body: ${{ steps.update-changelog.outputs.release-notes }}
steps:
- name: Checkout repository
uses: actions/checkout@v4
- uses: actions/checkout@v4
with:
ref: "main"
ref: main

- name: Update changelog
id: update-changelog
uses: thomaseizinger/[email protected]
with:
tag: ${{ github.ref_name }}
changelogPath: "docs/changelog.md"

- name: Configure Git
run: |
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
changelogPath: 'docs/changelog.md'

- name: Commit and push
run: |
git add docs/changelog.md
git commit --message "Bump version to ${{ github.ref_name }}"
uses: EndBug/add-and-commit@v9
with:
message: Bump version to ${{ github.ref_name }}
default_author: github_actions

publish-build:
name: Publish Assets
build:
name: Build
runs-on: ubuntu-latest
needs: bump
needs: changelog
steps:
- name: Checkout Repository
uses: actions/checkout@v4

- name: Setup Rokit
uses: CompeyDev/[email protected]

- name: Install Wally dependencies
run: wally install
- uses: actions/checkout@v4

- name: Generate sourcemap
run: rojo sourcemap standalone.project.json --output sourcemap.json
- name: Setup Pesde
uses: 2jammers/[email protected]
with:
cache: true

- name: Generate package types
run: wally-package-types --sourcemap sourcemap.json Packages
- name: Install dependencies
run: pesde install

- name: Format code
run: stylua src/

- name: Build standalone
- name: Standalone build
run: rojo build standalone.project.json --output ./Standalone.rbxm

- name: Draft release
uses: softprops/[email protected].8
- name: Standalone release
uses: softprops/[email protected].9
with:
tag_name: ${{ github.ref_name }}
name: ${{ github.ref_name }}
prerelease: ${{ contains(github.ref_name, 'rc') }}
generate_release_notes: true
body: |
## Changelog
${{ needs.bump.outputs.release-body }}
${{ needs.changelog.outputs.release-body }}
files: |
./Standalone.rbxm
publish-package:
name: Publish Package
package:
name: Package
runs-on: ubuntu-latest
needs: bump
needs: changelog
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup Rokit
uses: CompeyDev/[email protected]
- uses: actions/checkout@v4

- name: Log In
run: |
wally login --token "${{secrets.WALLY_AUTH_TOKEN}}"
- name: Setup Pesde
uses: 2jammers/[email protected]
with:
cache: true
token: '${{ secrets.PESDE_TOKEN }}'

- name: Publish
run: |
wally publish
pesde install
pesde publish -y
16 changes: 7 additions & 9 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
# Moonwave
venv
# Pesde
.pesde
roblox_packages
lune_packages
luau_packages
pesde.lock

# Wally
Packages
DevPackages
wally.lock

# Argon
# Rojo
sourcemap.json

7 changes: 0 additions & 7 deletions .vscode/settings.json

This file was deleted.

4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2024 Lumin Labs & Contributors
Copyright (c) 2025 Lumin & Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
39 changes: 34 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,36 @@
# Framework
# lumin/framework

[![license](https://img.shields.io/github/license/luminlabsdev/framework)](https://github.com/luminlabsdev/framework/blob/main/LICENSE)
[![release](https://img.shields.io/github/v/release/luminlabsdev/framework)](https://github.com/luminlabsdev/framework/releases/latest)
[![discord](https://img.shields.io/discord/1105688855375511642?logo=discord&logoColor=white&label=discord&color=4d3dff)](https://luminlabsdev.github.io/link/discord)
[![package](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Flumin-org%2Fframework%2Frefs%2Fheads%2Fmain%2Fpesde.toml&query=version&prefix=lumin%2Fui%40&style=plastic&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB3aWR0aD0iMTAwIiBoZWlnaHQ9IjEwMCIgdmlld0JveD0iMCAwIDEwMCAxMDAiIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI%2BCjxwYXRoIGZpbGwtcnVsZT0iZXZlbm9kZCIgY2xpcC1ydWxlPSJldmVub2RkIiBkPSJNNDkuNjAyNSAwTDkyLjkwMzggMjVWNzVMNDkuNjAyNSAxMDBMNi4zMDEyNyA3NVYyNUw0OS42MDI1IDBaTTE0LjMwMTMgMjkuNjE4OEw0OS42MDI1IDkuMjM3Nkw4NC45MDM4IDI5LjYxODhWNzAuMzgxMkw0OS42MDI1IDkwLjc2MjRMMzMuNjE0OCA4MS41MzE5VjY3LjM4NDhDMzQuNTE2NyA2OC41MDcxIDM1LjYzODggNjkuNDIxNSAzNi45ODEgNzAuMTI3OUMzOC45NzAxIDcxLjE0OCA0MS4wMzU3IDcxLjY1OCA0My4xNzc5IDcxLjY1OEM0Ni40NDIgNzEuNjU4IDQ5LjE0NTIgNzAuODkyOSA1MS4yODczIDY5LjM2MjlDNTMuNDgwNSA2Ny43ODE4IDU1LjExMjYgNjUuNzY3MiA1Ni4xODM2IDYzLjMxOUM1Ny4wOTE1IDYxLjMzODIgNTcuNjMyIDU5LjI3NCA1Ny44MDU0IDU3LjEyNjNDNTkuODcyMyA1Ny43NDU3IDYyLjIxNTcgNTguMDU1NCA2NC44MzU2IDU4LjA1NTRDNjcuNjkxOCA1OC4wNTU0IDcwLjM2OTUgNTcuNjQ3MyA3Mi44Njg2IDU2LjgzMTNDNzUuMzY3OCA1NS45NjQyIDc3LjQwNzkgNTQuODE2NyA3OC45ODkgNTMuMzg4Nkw3NS43NzU4IDQ3LjgwMzhDNzQuNTUxNyA0OC45MjU4IDcyLjk5NjEgNDkuODQzOSA3MS4xMDkgNTAuNTU3OUM2OS4yMjE5IDUxLjIyMSA2Ny4yMDczIDUxLjU1MjUgNjUuMDY1MiA1MS41NTI1QzYxLjM5MjkgNTEuNTUyNSA1OC42NjQzIDUwLjY4NTQgNTYuODc5MiA0OC45NTEzQzU2LjcxOTUgNDguNzk2MiA1Ni41NjcgNDguNjM2NSA1Ni40MjE3IDQ4LjQ3MkM1NS42MTAyIDQ3LjU1MzkgNTUuMDIxMSA0Ni40ODk2IDU0LjY1NDYgNDUuMjc5MUw1NC42NDQzIDQ1LjI0NTJMNTQuNjY5IDQ1LjI3OTFINzkuMjE4NVY0MS45ODk0Qzc5LjIxODUgMzkuMDMxMyA3OC41NTU1IDM2LjM1MzYgNzcuMjI5NCAzMy45NTY1Qzc1Ljk1NDMgMzEuNTU5MyA3NC4wOTI3IDI5LjY0NjcgNzEuNjQ0NSAyOC4yMTg2QzY5LjI0NzQgMjYuNzM5NSA2Ni4zNjU3IDI2IDYyLjk5OTUgMjZDNTkuNjg0MyAyNiA1Ni44MDI3IDI2LjczOTUgNTQuMzU0NSAyOC4yMTg2QzUxLjkwNjQgMjkuNjQ2NyA1MC4wMTkzIDMxLjU1OTMgNDguNjkzMiAzMy45NTY1QzQ3LjY3NDMgMzUuNzk4MyA0Ny4wNDY5IDM3LjgwNTcgNDYuODEwOCAzOS45Nzg4QzQ1LjY4ODggMzkuNzI4IDQ0LjQ3NzggMzkuNjAyNiA0My4xNzc5IDM5LjYwMjZDNDEuMDM1NyAzOS42MDI2IDM4Ljk3MDEgNDAuMTEyNyAzNi45ODEgNDEuMTMyN0MzNS4zMTYyIDQxLjk2NTEgMzMuOTkwMiA0My4xNTQ5IDMzLjAwMjggNDQuNzAyM1Y0MC4zNjc3SDIwLjY4NTVWNDYuMjU4NUgyNS44MTEzVjc3LjAyNjZMMTQuMzAxMyA3MC4zODEyVjI5LjYxODhaTTU1LjE5NjEgMzYuMDk4NkM1NC42NTI4IDM3LjEwMTUgNTQuMzMyMSAzOC4xMjE2IDU0LjIzNCAzOS4xNTg4SDcxLjc5NzZDNzEuNzk3NiAzOC4wMzY3IDcxLjQ0MDUgMzYuOTQwMSA3MC43MjY1IDM1Ljg2OTFDNzAuMDYzNCAzNC43NDcgNjkuMDY4OSAzMy44MDM1IDY3Ljc0MjggMzMuMDM4NEM2Ni40Njc3IDMyLjI3MzQgNjQuODg2NyAzMS44OTA4IDYyLjk5OTUgMzEuODkwOEM2MS4xMTI0IDMxLjg5MDggNTkuNTA1OCAzMi4yOTg5IDU4LjE3OTggMzMuMTE0OUM1Ni45MDQ3IDMzLjg4IDU1LjkxMDEgMzQuODc0NSA1NS4xOTYxIDM2LjA5ODZaTTQ5LjY0NTEgNTEuNTY5MkM0OS4zMDc2IDUwLjY2NDEgNDguODM4MSA0OS44NzEgNDguMjM2NyA0OS4xODk4QzQ4LjA4ODUgNDkuMDIxOSA0Ny45MzIzIDQ4Ljg2MDkgNDcuNzY4MSA0OC43MDY3QzQ2LjA4NSA0Ny4wNzQ2IDQ0LjA0NDkgNDYuMjU4NSA0MS42NDc4IDQ2LjI1ODVDNDAuMTE3NyA0Ni4yNTg1IDM4LjYxMzEgNDYuNTY0NSAzNy4xMzQgNDcuMTc2NkMzNS44NTk0IDQ3LjY3NzMgMzQuNjg2MyA0OC41NDM4IDMzLjYxNDggNDkuNzc1OVY2MS40N0MzNC42ODYzIDYyLjY2NjQgMzUuODU5NCA2My41Mzc4IDM3LjEzNCA2NC4wODRDMzguNjEzMSA2NC42OTYxIDQwLjExNzcgNjUuMDAyMSA0MS42NDc4IDY1LjAwMjFDNDQuMDQ0OSA2NS4wMDIxIDQ2LjA4NSA2NC4xODYxIDQ3Ljc2ODEgNjIuNTU0QzQ5LjQ1MTIgNjAuOTIxOSA1MC4yOTI4IDU4LjYwMTIgNTAuMjkyOCA1NS41OTIxQzUwLjI5MjggNTQuMDY3OSA1MC4wNzY5IDUyLjcyNyA0OS42NDUxIDUxLjU2OTJaIiBmaWxsPSJ3aGl0ZSIvPgo8L3N2Zz4K&label=pesde&color=F19D1E)](https://pesde.dev/packages/lumin/framework)
[![ci](https://img.shields.io/github/actions/workflow/status/lumin-org/framework/release.yml?style=plastic&logo=github&logoColor=FFFFFF&label=ci)](https://github.com/lumin-org/framework/blob/main/.github/workflows/release.yml)
[![discord](https://img.shields.io/discord/1105688855375511642?logo=discord&logoColor=white&label=chat&color=4d3dff&style=plastic)](https://lumin-org.github.io/to/discord)

A lightning fast & efficient framework for Roblox.
A featherlight and quick framework for Roblox experiences.

## Prerequisites

In order to use **lumin/framework** you must have the following dependencies installed:

* [`pesde@^0.5.1`](https://github.com/pesde-pkg/pesde)
* [`rojo@^7.4.4`](https://github.com/rojo-rbx/rojo)

## Usage

This usage examples creates a new, and basic controller that uses another dependency.

```luau
local Framework = require(path.to.framework)
local Dependency = require(path.to.dependency)
local function Init()
Dependency.NuclearExplosion()
end
return Framework.New {
Init = Init,
Uses = { Dependency } -- Makes the dependency load first
}
```

# License

This project is licensed under the [MIT](https://github.com/lumin-org/framework/blob/main/LICENSE) license
6 changes: 0 additions & 6 deletions default.project.json

This file was deleted.

24 changes: 9 additions & 15 deletions dev.project.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,17 @@
"tree": {
"$className": "DataModel",
"ReplicatedStorage": {
"DevPackages": {
"$path": "DevPackages"
},
"Packages": {
"$path": "Packages",
"framework": {
"framework": {
"$className": "Folder",
"src": {
"$path": "src"
}
},
"Tests": {
"$className": "Folder",
"Client": {
"$path": "tests/client"
},
"Server": {
"$path": "tests/server"
}
"roblox_packages": {
"$path": "roblox_packages"
}
},
"tests": {
"$path": "tests"
}
}
}
Expand Down
83 changes: 0 additions & 83 deletions mkdocs.yml

This file was deleted.

Loading

0 comments on commit 93a7053

Please sign in to comment.