chore: move docs and examples in to create a monorepo (blake-mealey#168)

* move content into subdir to prep for monorepo

* copy docs site into monorepo

* added the example repo to the monorepo

* fixed examples links

* fixed projects paths in examples

* more fixes

Author: blake-mealey

.github/workflows/ci.yml

@@ -20,13 +20,16 @@ jobs:
             ~/.cargo/registry/index/
             ~/.cargo/registry/cache/
             ~/.cargo/git/db/
-            target/
+            mantle/target/
           key: ${{ runner.os }}-ci-cargo-${{ hashFiles('**/Cargo.lock') }}
       - name: Build
+        working-directory: mantle
         run: cargo build --locked --verbose
       - name: Run linters
+        working-directory: mantle
         run: |
           cargo fmt -- --check
           cargo clippy -- -D warnings
       - name: Generate schema
+        working-directory: mantle
         run: cargo run --bin gen_schema

.github/workflows/integration-tests.yml

@@ -16,9 +16,10 @@ jobs:
             ~/.cargo/registry/index/
             ~/.cargo/registry/cache/
             ~/.cargo/git/db/
-            target/
+            mantle/target/
           key: ${{ runner.os }}-integration-cargo-${{ hashFiles('**/Cargo.lock') }}
       - name: Run integration tests
+        working-directory: mantle
         run: cargo test --locked --test '*' -- --test-threads=1
         env:
           ROBLOSECURITY: ${{ secrets.INTEGRATION_TESTS_COOKIE }}

.github/workflows/release.yml

@@ -18,15 +18,16 @@ jobs:
             ~/.cargo/registry/index/
             ~/.cargo/registry/cache/
             ~/.cargo/git/db/
-            target/
+            mantle/target/
           key: ${{ runner.os }}-release-cargo-${{ hashFiles('**/Cargo.lock') }}
       - name: Build release binary
+        working-directory: mantle
         run: cargo build --verbose --locked --release
       - name: Zip binary
         uses: thedoctor0/[email protected]
         with:
           filename: mantle-win64.zip
-          path: target/release/mantle.exe
+          path: mantle/target/release/mantle.exe
       - name: Upload binary artifact
         uses: actions/upload-artifact@v2
         with:
@@ -43,11 +44,12 @@ jobs:
             ~/.cargo/registry/index/
             ~/.cargo/registry/cache/
             ~/.cargo/git/db/
-            target/
+            mantle/target/
           key: ${{ runner.os }}-release-cargo-${{ hashFiles('**/Cargo.lock') }}
       - name: Install rust
         run: curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
       - name: Build release binary
+        working-directory: mantle
         run: |
           source $HOME/.cargo/env
           cargo build --verbose --locked --release
@@ -57,7 +59,7 @@ jobs:
         uses: thedoctor0/[email protected]
         with:
           filename: mantle-macos.zip
-          path: target/release/mantle
+          path: mantle/target/release/mantle
       - name: Upload binary artifact
         uses: actions/upload-artifact@v2
         with:
@@ -74,29 +76,31 @@ jobs:
             ~/.cargo/registry/index/
             ~/.cargo/registry/cache/
             ~/.cargo/git/db/
-            target/
+            mantle/target/
           key: ${{ runner.os }}-release-cargo-${{ hashFiles('**/Cargo.lock') }}
       - name: Build release binary
+        working-directory: mantle
         run: cargo build --locked --verbose --release
         env:
           OPENSSL_STATIC: 1
       - name: Zip binary
         uses: thedoctor0/[email protected]
         with:
           filename: mantle-linux.zip
-          path: target/release/mantle
+          path: mantle/target/release/mantle
       - name: Upload binary artifact
         uses: actions/upload-artifact@v2
         with:
           name: mantle-linux
           path: mantle-linux.zip
       - name: Generate schema
+        working-directory: mantle
         run: cargo run --release --bin gen_schema > schema.json
       - name: Upload schema artifact
         uses: actions/upload-artifact@v2
         with:
           name: schema
-          path: schema.json
+          path: mantle/schema.json
   release:
     runs-on: ubuntu-latest
     needs: [windows, macos, linux]

.gitignore

@@ -1,15 +1,7 @@
-/target
-integration_tmp
+node_modules
 
 *.env
 
-*.rbxl
-*.rbxlx
-*.rbxl.lock
-*.rbxlx.lock
-
-*.png
-
 *.DS_Store
 
 *.log

Cargo.toml

@@ -2,20 +2,11 @@
 
 An infrastructure-as-code and deployment tool for Roblox.
 
-## Installation with Foreman
+This is a monorepo for the Mantle project. You can find further information about subprojects within the
+directories:
 
-It is recommended to install with Foreman, with the following config:
+- [mantle](mantle/README.md): the Mantle project itself.
+- [docs](docs/README.md): the docs site for the Mantle project.
+- [examples](examples/README.md): example Mantle projects.
 
-```toml
-# foreman.toml
-
-[tools]
-mantle = { source = "blake-mealey/mantle", version = "0.11.3" }
-```
-
-You can learn more about Foreman including how to install it from [its
-documentation](https://github.com/Roblox/foreman#readme).
-
-## Documentation
-
-Check out the [docs site](https://mantle-docs.vercel.app) for more info.
+For more information about the project, visit the [docs site](https://mantledeploy.vercel.app).

README.md

@@ -0,0 +1,25 @@
+# Dependencies
+node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+docs/configuration.md
+static/schemas
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Dev
+/schema.json

bump-version.ps1

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Blake Mealey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+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.

docs/.gitignore

@@ -0,0 +1,23 @@
+# Mantle Docs
+
+The [docs site](https://mantledeploy.vercel.app).
+
+## Local development
+
+Install:
+
+```sh
+yarn install
+```
+
+Build and watch the schema docs:
+
+```sh
+yarn compile-template-docs:dev
+```
+
+Build and watch the site:
+
+```sh
+yarn dev
+```