Merge pull request #28384 from ProvableHQ/refactor/leo-examples

[Refactor] Remove `examples` and add it back in as a submodule

.circleci/config.yml

@@ -57,6 +57,9 @@ jobs:
       - install_rust_nightly
       - setup_environment:
           cache_key: leo-fmt-cache
+      - run:
+          name: Update Submodules
+          command: git submodule update --init --recursive
       - run:
           name: Check style
           no_output_timeout: 35m
@@ -72,6 +75,9 @@ jobs:
       - checkout
       - setup_environment:
           cache_key: leo-clippy-cache
+      - run:
+          name: Update Submodules
+          command: git submodule update --init --recursive
       - run:
           name: Clippy
           no_output_timeout: 35m
@@ -89,6 +95,9 @@ jobs:
       - checkout
       - setup_environment:
           cache_key: leo-executable-cache
+      - run:
+          name: Update Submodules
+          command: git submodule update --init --recursive
       - run:
           name: Build and install Leo
           no_output_timeout: 30m

.github/workflows/acl2.yml

@@ -11,6 +11,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
+        with:
+          submodules: true
 
       - name: Install Rust
         uses: actions-rs/toolchain@v1

.github/workflows/ci.yml

@@ -31,6 +31,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
+        with:
+          submodules: true
 
       - name: Install sccache Ubuntu
         if: matrix.os == 'ubuntu-latest'
@@ -109,6 +111,8 @@ jobs:
 
       - name: Checkout
         uses: actions/checkout@v2
+        with:
+          submodules: true
 
       - name: Install sccache
         run: |
@@ -165,6 +169,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
+        with:
+          submodules: true
 
       - name: Install Rust Stable
         uses: actions-rs/toolchain@v1
@@ -189,6 +195,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
         with:
+          submodules: true
           ref: mainnet
 
       - name: Install sccache
@@ -257,6 +264,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v1
+        with:
+          submodules: true
 
       - name: Install sccache Ubuntu
         env:

.github/workflows/codecov.yml

@@ -20,7 +20,9 @@ jobs:
       SCCACHE_DIR: /home/runner/.cache/sccache
     steps:
       - name: Checkout
-        uses: actions/checkout@v1
+        uses: actions/checkout@v2
+        with:
+          submodules: true
 
       - name: Install sccache Ubuntu
         env:

.github/workflows/docs.yml

@@ -17,6 +17,8 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
         with:
+          with:
+            submodules: true
           ref: mainnet
 
       - name: Install sccache

.github/workflows/markdown.yml

@@ -12,6 +12,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
         with:
+          submodules: true
           fetch-depth: 2
 
       - name: Get changed files

.github/workflows/release.yml

@@ -14,7 +14,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v1
+        uses: actions/checkout@v2
+        with:
+          submodules: true
 
       - name: Install Rust
         uses: actions-rs/toolchain@v1
@@ -98,7 +100,9 @@ jobs:
     runs-on: macos-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v1
+        uses: actions/checkout@v2
+        with:
+          submodules: true
 
       - name: Install Rust
         uses: actions-rs/toolchain@v1
@@ -146,6 +150,8 @@ jobs:
 
       - name: Checkout
         uses: actions/checkout@v2
+        with:
+          submodules: true
 
       - name: Install Rust
         uses: actions-rs/toolchain@v1
@@ -202,6 +208,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
+        with:
+          submodules: true
 
       - name: Install Rust
         uses: actions-rs/toolchain@v1

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "examples"]
+	path = examples
+	url = https://github.com/ProvableHQ/leo-examples

README.md

@@ -67,8 +67,8 @@ We recommend installing Rust using [rustup](https://www.rustup.rs/). You can ins
 We recommend installing Leo by building from the source code as follows:
 
 ```bash
-# Download the source code
-git clone https://github.com/ProvableHQ/leo
+# Download the source code and initialize the submodules
+git clone --recurse-submodules https://github.com/ProvableHQ/leo
 cd leo
 
 # Install 'leo'