Add script to check rust versions + cleanup (#272)

* ci: turn doc warnings into errors (#259) * remove unnecessary comments * Add script to check rust versions * removed versions and editions except from root, updated script * add back cargo make doc to ci * Added section for testing * Fixed typo * Set versions to 0.1.0 + inherit all infos from workspace * Fix use of versioning * Set individual versions for crates * Fixed nits, code organization and updated links * Improve naming of ci job * Fix formatting in contributing.md * Add task to format not only check * Reduced indent --------- Co-authored-by: Augusto Hack <hack.augusto@gmail.com>
0xPolygonMiden · Mar 14, 2024 · 5c79ccb · 5c79ccb
1 parent f3e68f6
commit 5c79ccb
Show file tree

Hide file tree

Showing 13 changed files with 103 additions and 51 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -7,6 +7,17 @@ on:
     types: [opened, reopened, synchronize]
 
 jobs:
+  version:
+    name: check rust version consistency
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          profile: minimal
+          override: true
+      - name: check rust versions
+        run: ./scripts/check-rust-version.sh
+
   rustfmt:
     name: rustfmt nightly on ubuntu-latest
     runs-on: ubuntu-latest

diff --git a/.gitignore b/.gitignore
@@ -1,15 +1,12 @@
 # Generated by Cargo
+
 # will have compiled files and executables
 debug/
 target/
 
 # Generated by protox `file_descriptor_set.bin`
 *.bin
 
-# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
-# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
-# Cargo.lock
-
 # These are backup files generated by rustfmt
 **/*.rs.bk
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,10 +4,10 @@
 
 We want to make contributing to this project as easy and transparent as possible, whether it's:
 
-- Reporting a [bug](https://github.com/0xPolygonMiden/miden-node/issues/new)
+- Reporting a [bug](https://github.com/0xPolygonMiden/miden-node/issues/new?assignees=&labels=bug&projects=&template=1-bugreport.yml&title=%5BBug%5D%3A+)
 - Taking part in [discussions](https://github.com/0xPolygonMiden/miden-node/discussions)
 - Submitting a [fix](https://github.com/0xPolygonMiden/miden-node/pulls)
-- Proposing new [features](https://github.com/0xPolygonMiden/miden-node/issues/new)
+- Proposing new [features](https://github.com/0xPolygonMiden/miden-node/issues/new?assignees=&labels=enhancement&projects=&template=2-feature-request.yml&title=%5BFeature%5D%3A+)
 
 &nbsp;
 
@@ -80,6 +80,13 @@ For example, a new change to the `miden-node-store` crate might have the followi
 
 You can find more information about the `cargo make` commands in the [Makefile](Makefile.toml)
 
+### Testing
+After writing code different types of tests (unit, integration, end-to-end) are required to make sure that the correct behavior has been achieved and that no bugs have been introduced. You can run tests using the following command:
+
+```
+cargo make test
+```
+
 ### Versioning
 We use [semver](https://semver.org/) naming convention.
 

diff --git a/Cargo.toml b/Cargo.toml
@@ -8,8 +8,19 @@ members = [
   "utils",
   "test-macro",
 ]
+
 resolver = "2"
 
+[workspace.package]
+edition = "2021"
+rust-version = "1.75"
+license = "MIT"
+authors = ["Miden contributors"]
+readme = "README.md"
+homepage = "https://polygon.technology/polygon-miden"
+repository = "https://github.com/0xPolygonMiden/miden-node"
+exclude = [".github/"]
+
 [workspace.dependencies]
 miden-air = { version = "0.8", default-features = false }
 miden-lib = { version = "0.1" }

diff --git a/Makefile.toml b/Makefile.toml
@@ -6,6 +6,11 @@ CARGO_MAKE_EXTEND_WORKSPACE_MAKEFILE = true
 [tasks.format]
 toolchain = "nightly"
 command = "cargo"
+args = ["fmt", "--all"]
+
+[tasks.format-check]
+toolchain = "nightly"
+command = "cargo"
 args = ["fmt", "--all", "--", "--check"]
 
 [tasks.clippy-default]
@@ -34,6 +39,7 @@ args = ["test", "--all-features", "--workspace", "--", "--nocapture"]
 [tasks.lint]
 dependencies = [
     "format",
+    "format-check",
     "clippy",
     "docs"
 ]
diff --git a/block-producer/Cargo.toml b/block-producer/Cargo.toml
@@ -2,13 +2,14 @@
 name = "miden-node-block-producer"
 version = "0.2.0"
 description = "Miden node's block producer component"
-authors = ["miden contributors"]
-readme = "README.md"
-license = "MIT"
-repository = "https://github.com/0xPolygonMiden/miden-node"
-keywords = ["miden", "node", "store"]
-edition = "2021"
-rust-version = "1.75"
+keywords = ["miden", "node", "block-producer"]
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+authors.workspace = true
+readme.workspace = true
+homepage.workspace = true
+repository.workspace = true
 
 [[bin]]
 name = "miden-node-block-producer"

diff --git a/node/Cargo.toml b/node/Cargo.toml
@@ -1,14 +1,15 @@
 [package]
 name = "miden-node"
 version = "0.2.0"
-description = "Miden node single binary"
-authors = ["miden contributors"]
-readme = "README.md"
-license = "MIT"
-repository = "https://github.com/0xPolygonMiden/miden-node"
+description = "Miden node binary"
 keywords = ["miden", "node"]
-edition = "2021"
-rust-version = "1.75"
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+authors.workspace = true
+readme.workspace = true
+homepage.workspace = true
+repository.workspace = true
 
 [features]
 # Makes `make-genesis` subcommand run faster. Is only suitable for testing.

diff --git a/proto/Cargo.toml b/proto/Cargo.toml
@@ -2,13 +2,14 @@
 name = "miden-node-proto"
 version = "0.2.0"
 description = "Miden RPC message definitions"
-authors = ["miden contributors"]
-readme = "README.md"
-license = "MIT"
-repository = "https://github.com/0xPolygonMiden/miden-node"
 keywords = ["miden", "node", "protobuf", "rpc"]
-edition = "2021"
-rust-version = "1.75"
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+authors.workspace = true
+readme.workspace = true
+homepage.workspace = true
+repository.workspace = true
 
 [dependencies]
 hex = { version = "0.4" }

diff --git a/rpc/Cargo.toml b/rpc/Cargo.toml
@@ -2,13 +2,14 @@
 name = "miden-node-rpc"
 version = "0.2.0"
 description = "Miden node's front-end RPC server"
-authors = ["miden contributors"]
-readme = "README.md"
-license = "MIT"
-repository = "https://github.com/0xPolygonMiden/miden-node"
 keywords = ["miden", "node", "rpc"]
-edition = "2021"
-rust-version = "1.75"
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+authors.workspace = true
+readme.workspace = true
+homepage.workspace = true
+repository.workspace = true
 
 [dependencies]
 anyhow = { version = "1.0" }

diff --git a/scripts/check-rust-version.sh b/scripts/check-rust-version.sh
@@ -0,0 +1,13 @@
+#!/bin/bash
+
+# Check rust-toolchain file
+TOOLCHAIN_VERSION=$(cat rust-toolchain)
+
+# Check workspace Cargo.toml file
+CARGO_VERSION=$(cat Cargo.toml | grep "rust-version" | cut -d '"' -f 2)
+if [ "$CARGO_VERSION" != "$TOOLCHAIN_VERSION" ]; then
+    echo "Mismatch in $file. Expected $TOOLCHAIN_VERSION, found $CARGO_VERSION"
+    exit 1
+fi
+
+echo "Rust versions match ✅"
diff --git a/store/Cargo.toml b/store/Cargo.toml
@@ -2,13 +2,14 @@
 name = "miden-node-store"
 version = "0.2.0"
 description = "Miden node's state store component"
-authors = ["miden contributors"]
-readme = "README.md"
-license = "MIT"
-repository = "https://github.com/0xPolygonMiden/miden-node"
 keywords = ["miden", "node", "store"]
-edition = "2021"
-rust-version = "1.75"
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+authors.workspace = true
+readme.workspace = true
+homepage.workspace = true
+repository.workspace = true
 
 [[bin]]
 name = "miden-node-store"

diff --git a/test-macro/Cargo.toml b/test-macro/Cargo.toml
@@ -1,14 +1,15 @@
 [package]
 name = "miden-node-test-macro"
 version = "0.1.0"
-description = "Miden's test macro"
-authors = ["miden contributors"]
-readme = "README.md"
-license = "MIT"
-repository = "https://github.com/0xPolygonMiden/miden-node"
+description = "Miden node's test macro"
 keywords = ["miden", "node", "utils", "macro"]
-edition = "2021"
-rust-version = "1.75"
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+authors.workspace = true
+readme.workspace = true
+homepage.workspace = true
+repository.workspace = true
 
 [dependencies]
 quote = { version = "1.0" }

diff --git a/utils/Cargo.toml b/utils/Cargo.toml
@@ -2,13 +2,14 @@
 name = "miden-node-utils"
 version = "0.2.0"
 description = "Miden node's shared utilities"
-authors = ["miden contributors"]
-readme = "README.md"
-license = "MIT"
-repository = "https://github.com/0xPolygonMiden/miden-node"
 keywords = ["miden", "node", "utils"]
-edition = "2021"
-rust-version = "1.75"
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+authors.workspace = true
+readme.workspace = true
+homepage.workspace = true
+repository.workspace = true
 
 [dependencies]
 anyhow = { version = "1.0" }