Merge pull request #1 from Bytebit-Org/task/add-ci-and-release

Task/add ci and release

.github/workflows/CI.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on: [push, workflow_dispatch]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: install selene
+        run: |
+          curl https://github.com/Kampfkarren/selene/releases/download/0.9.1/selene-linux -L -o selene
+          chmod +x ./selene
+      - name: run selene
+        run: ./selene ./src
+  unit-tests:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: download roblox install script
+        run: Invoke-WebRequest -Uri "https://raw.githubusercontent.com/OrbitalOwen/roblox-win-installer/master/install.py" -OutFile install.py
+      - name: download settings file
+        run: Invoke-WebRequest -Uri "https://raw.githubusercontent.com/OrbitalOwen/roblox-win-installer/master/GlobalSettings_13.xml" -OutFile GlobalSettings_13.xml
+      - name: install pip deps
+        run: pip install wget psutil
+      - name: install roblox
+        run: python install.py "${{ secrets.ROBLOSECURITY }}"
+      - name: install foreman
+        uses: rojo-rbx/setup-foreman@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - name: install foreman packages (rojo, run-in-roblox)
+        run: foreman install
+      - name: install wally packages
+        run: wally install
+      - name: run rojo build
+        run: rojo build -o .\\unit_tests.rbxlx .\\unit-tests.project.json
+      - name: run tests
+        run: run-in-roblox --place .\\unit_tests.rbxlx --script .\\spec.server.lua

.github/workflows/Release.yml

@@ -0,0 +1,63 @@
+name: Release
+
+on: [workflow_dispatch]
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: install python dependencies
+        run: pip3 install -r requirements.txt
+      - name: get wally version
+        id: get_wally_version
+        run: echo "::set-output name=version-string::$(python3 ./scripts/get_wally_version_string.py)"
+      - name: install foreman
+        uses: rojo-rbx/setup-foreman@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - name: install foreman packages (rojo, run-in-roblox)
+        run: foreman install
+      - name: install wally packages
+        run: wally install
+      - name: run rojo build
+        run: rojo build -o ./linalg-${{ steps.get_wally_version.outputs.version-string }}.rbxmx ./standalone-model.project.json
+      - name: create-release
+        uses: actions/create-release@latest
+        id: create_release
+        with:
+          draft: false
+          prerelease: false
+          release_name: ${{ steps.get_wally_version.outputs.version-string }}
+          tag_name: ${{ steps.get_wally_version.outputs.version-string }}
+          body_path: CHANGELOG.md
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+      - name: upload rbxmx file to release
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./linalg-${{ steps.get_wally_version.outputs.version-string }}.rbxmx
+          asset_name: linalg-${{ steps.get_wally_version.outputs.version-string }}.rbxmx
+          asset_content_type: form
+      - name: upload rbxmx file to Roblox
+        run: |
+          cd ./scripts
+          python upload_model.py -a ${{ secrets.ASSET_ID }} -f ../linalg-${{ steps.get_wally_version.outputs.version-string }}.rbxmx -r "${{ secrets.UPLOADER_BOT_ROBLOSECURITY }}"
+          cd ..
+      - name: prepare wally package contents
+        run: |
+          mkdir -p ~/temp/linalg
+          cp -r ./{include,out} ~/temp/linalg/
+          cp ./{CHANGELOG.md,LICENSE,README.md,wally.lock,wally.toml} ~/temp/linalg/
+          cp ./standalone-model.project.json ~/temp/linalg/default.project.json
+          mkdir ~/temp/linalg/node_modules
+          cp -r ./node_modules/@rbxts ~/temp/linalg/node_modules/
+      - name: prepare wally auth
+        run: |
+          mkdir ~/.wally
+          echo -e '${{ secrets.WALLY_AUTH }}' > ~/.wally/auth.toml
+      - name: publish wally package
+        run: wally publish --project-path ~/temp/linalg/

.gitignore

@@ -2,3 +2,4 @@
 .vscode
 quickTesting.lua
 luacov.stats.out
+Packages

CHANGELOG.md

@@ -0,0 +1 @@
+Releases!

README.md

@@ -1,4 +1,4 @@
-Lua Linear Algebra
+# Lua Linear Algebra
 ===
 
 <div align="center">
@@ -12,7 +12,22 @@ Lua Linear Algebra
 
 A simple script to implement linear algebra functions not provided by the Lua standard API, developed especially for use on Roblox
 
-Documentation
+## Installation
+### Wally
+[Wally](https://github.com/UpliftGames/wally/) users can install this package by adding the following line to their `Wally.toml` under `[dependencies]`:
+```
+linalg = "bytebit/linalg@0.0.1"
+```
+
+Then just run `wally install`.
+
+### From model file
+Model files are uploaded to every release as `.rbxmx` files. You can download the file from the [Releases page](https://github.com/Bytebit-Org/lua-linalg/releases) and load it into your project however you see fit.
+
+### From model asset
+New versions of the asset are uploaded with every release. The asset can be added to your Roblox Inventory and then inserted into your Place via Toolbox by getting it [here.](https://www.roblox.com/library/7881451885/linalg-Package)
+
+## Documentation
 ---
 
 ### Matrix Functions

foreman.toml

@@ -0,0 +1,4 @@
+[tools]
+rojo = { source = "rojo-rbx/rojo", version = "6" }
+run-in-roblox = { source = "rojo-rbx/run-in-roblox", version = "0.3.0" }
+wally = { source = "UpliftGames/wally", version = "0.2.1" }