Migrate addon code to the `master` branch as a package - Githubissues

gelly-gmod / gelly

Library to integrate fluids into a game engine

GNU General Public License v3.0

18 stars 3 forks source link

Migrate addon code to the `master` branch as a package #61

Closed Derpius closed 2 months ago

Derpius commented 2 months ago

Context

Most of gelly is organised into a monorepository structure
The addon however has been placed onto a separate sp-addon branch
This causes confusion for less-experienced potential contributors as seen in Discord
It also makes development harder as you need to switch between multiple branches and can't change something in the addon and binary simultaneously

Scope

Copy the contents of the sp-addon branch to packages/addon or equivalent
- Ensure any configs like stylua.toml are moved to the root of the master branch
Update the build script to pass that directory to gmad
Update the github workflow to no longer clone the sp-addon branch
Delete the sp-addon branch after this is merged
Could: Documentation on how to symlink the packages/addon directory to garrysmod/addons on Windows at minimum

Acceptance Criteria

Addon code is present on the master branch
Build script and GitHub workflow have no regressions
sp-addon branch is deleted

Other

No response