Move build all examples (FuelLabs#1398)

* Move build-all-examples to scripts * Remove print * Reorder scripts/build-all-examples alphabetically * use clap for build-all-examples * Cargo.lock update * Take paths for build-all-examples * Remove unused import * Rename build-all-examples -> build-examples * Update ci.yml with new build-examples command * Update Cargo.lock * Add help text for build-examples script * Use --all and --paths args to differentiate between building all and specific paths * build-examples --all -> --all-examples to make it even more explicit * Better description for script * Refactor script * Rename build-examples to examples-checker * update Cargo.toml and Cargo.lock with new script name * Update CI workflow * Better usage of Path * Remove redundant builds, add dedicated fmt job * Remove usage of success bool in run_forc_command * Use [] instead of &Vec<> * handle print_summary failure as error instead of exit(1) Co-authored-by: bing <[email protected]>
mosker · May 2, 2022 · b89ec66 · b89ec66
1 parent 1d149d8
commit b89ec66
Show file tree

Hide file tree

Showing 7 changed files with 226 additions and 119 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -77,11 +77,36 @@ jobs:
         with:
           command: install
           args: --debug --path ./forc-fmt
-      - name: Build Sway examples and check formatting
+      - name: Build Sway examples
         uses: actions-rs/cargo@v1
         with:
           command: run
-          args: --bin build-all-examples
+          args: --bin examples-checker build --all-examples
+
+  forc-fmt-check-sway-examples:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+      - uses: Swatinem/rust-cache@v1
+      - name: Install Forc
+        uses: actions-rs/cargo@v1
+        with:
+          command: install
+          args: --debug --path ./forc
+      - name: Install Forc fmt
+        uses: actions-rs/cargo@v1
+        with:
+          command: install
+          args: --debug --path ./forc-fmt
+      - name: Check Sway examples formatting
+        uses: actions-rs/cargo@v1
+        with:
+          command: run
+          args: --bin examples-checker fmt --all-examples
 
   build-mdbook:
     needs: cancel-previous-runs
@@ -122,11 +147,11 @@ jobs:
         with:
           command: install
           args: --debug --path ./forc-fmt
-      - name: Build Sway examples and check formatting
+      - name: Build Sway examples
         uses: actions-rs/cargo@v1
         with:
           command: run
-          args: --bin build-all-examples
+          args: --bin examples-checker build --all-examples
       - uses: actions-rs/cargo@v1
         name: Cargo Build Workspace
         with:
@@ -154,11 +179,11 @@ jobs:
         with:
           command: install
           args: --debug --path ./forc-fmt
-      - name: Build Sway examples and check formatting
+      - name: Build Sway examples
         uses: actions-rs/cargo@v1
         with:
           command: run
-          args: --bin build-all-examples
+          args: --bin examples-checker build --all-examples
       - name: Check Clippy Linter
         uses: actions-rs/cargo@v1
         with:
@@ -242,11 +267,11 @@ jobs:
         with:
           command: install
           args: --debug --path ./forc-fmt
-      - name: Build Sway examples and check formatting
+      - name: Build Sway examples
         uses: actions-rs/cargo@v1
         with:
           command: run
-          args: --bin build-all-examples
+          args: --bin examples-checker build --all-examples
       - name: Build All Tests
         run: cd test/src/sdk-harness && bash build.sh && cd ../../../
       - name: Cargo Test sway-lib-std
@@ -275,11 +300,11 @@ jobs:
         with:
           command: install
           args: --debug --path ./forc-fmt
-      - name: Build Sway examples and check formatting
+      - name: Build Sway examples
         uses: actions-rs/cargo@v1
         with:
           command: run
-          args: --bin build-all-examples
+          args: --bin examples-checker build --all-examples
       - name: Run tests
         uses: actions-rs/cargo@v1
         with:
@@ -327,11 +352,11 @@ jobs:
         with:
           command: install
           args: --debug --path ./forc-fmt
-      - name: Build Sway examples and check formatting
+      - name: Build Sway examples
         uses: actions-rs/cargo@v1
         with:
           command: run
-          args: --bin build-all-examples
+          args: --bin examples-checker build --all-examples
       - name: Install cargo-udeps
         uses: actions-rs/cargo@v1
         with:

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -2,14 +2,14 @@
 resolver = "2"
 members = [
     "docstrings",
-    "examples/build-all-examples",
     "forc",
     "forc-explore",
     "forc-fmt",
     "forc-gm",
     "forc-lsp",
     "forc-pkg",
     "forc-util",
+    "scripts/examples-checker",
     "scripts/forc-documenter",
     "sway-core",
     "sway-fmt",

diff --git a/examples/build-all-examples/Cargo.toml b/examples/build-all-examples/Cargo.toml
diff --git a/examples/build-all-examples/src/main.rs b/examples/build-all-examples/src/main.rs
diff --git a/scripts/examples-checker/Cargo.toml b/scripts/examples-checker/Cargo.toml
@@ -0,0 +1,10 @@
+[package]
+name = "examples-checker"
+description = "Runs `forc build` or `forc fmt --check` on Sway projects specified by paths or within Sway `examples` directory."
+version = "0.0.0"
+edition = "2021"
+publish = false
+
+[dependencies]
+anyhow = "1.0.41"
+clap = { version = "3.1", features = ["env", "derive"] }