ci: test both MSRV and latest stable Rust versions

.commitlintrc.json

@@ -0,0 +1 @@
+{ "extends": ["@commitlint/config-conventional"] }

.github/workflows/ci.yml

@@ -12,15 +12,39 @@ env:
 jobs:
   ci:
     runs-on: "ubuntu-latest"
-
+    strategy:
+      matrix:
+        rust-version: ["1.70.0", "stable"]
     steps:
-      - uses: "actions/checkout@v4"
+      - uses: "actions/checkout@v4.1.1"
-      - uses: "dtolnay/rust-toolchain@stable"
-        with:
-          components: "clippy, rustfmt"
-      - run: "rustc --version"
 
+      - uses: "dtolnay/rust-toolchain@master"
+        with:
+          toolchain: "${{ matrix.rust-version }}"
+          components: "clippy, rustfmt"
+
+      - run: "rustc --version"
       - run: "cargo build --verbose"
       - run: "cargo test --verbose"
       - run: "cargo clippy --verbose -- -D warnings"
       - run: "cargo fmt -- --check"
+
+  lint-markdown:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v4.1.1"
+
+      - uses: "DavidAnson/markdownlint-cli2-action@v15.0.0"
+        with:
+          config: ".markdownlint-cli2.jsonc"
+          globs: "**/*.md"
+
+  lint-commit:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v4.1.1"
+
+      - uses: "wagoid/commitlint-github-action@v5.4.5"
+        with:
+          configFile: ".commitlintrc.json"
+          failOnWarnings: true

.markdownlint-cli2.jsonc

@@ -0,0 +1,31 @@
+{
+    "config": {
+        "default": true,
+
+        /* Disables rules that may conflict with Prettier */
+        /* Reference: https://github.com/DavidAnson/markdownlint/blob/main/style/prettier.json */
+        "blanks-around-fences": false,
+        "blanks-around-headings": false,
+        "blanks-around-lists": false,
+        "code-fence-style": false,
+        "emphasis-style": false,
+        "heading-start-left": false,
+        "hr-style": false,
+        "line-length": false,
+        "list-indent": false,
+        "list-marker-space": false,
+        "no-blanks-blockquote": false,
+        "no-hard-tabs": false,
+        "no-missing-space-atx": false,
+        "no-missing-space-closed-atx": false,
+        "no-multiple-blanks": false,
+        "no-multiple-space-atx": false,
+        "no-multiple-space-blockquote": false,
+        "no-multiple-space-closed-atx": false,
+        "no-trailing-spaces": false,
+        "ol-prefix": false,
+        "strong-style": false,
+        "ul-indent": false
+    },
+    "globs": ["**/*.md"]
+}

Cargo.lock

@@ -174,9 +174,9 @@ checksum = "7170ef9988bc169ba16dd36a7fa041e5c4cbeb6a35b76d4c03daded371eae7c0"
 
 [[package]]
 name = "rayon"
-version = "1.8.0"
+version = "1.8.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9c27db03db7734835b3f53954b534c91069375ce6ccaa2e065441e07d9b6cdb1"
+checksum = "fa7237101a77a10773db45d62004a272517633fbcc3df19d96455ede1122e051"
 dependencies = [
  "either",
  "rayon-core",
@@ -184,9 +184,9 @@ dependencies = [
 
 [[package]]
 name = "rayon-core"
-version = "1.12.0"
+version = "1.12.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5ce3fb6ad83f861aac485e76e1985cd109d9a3713802152be56c3b1f0e0658ed"
+checksum = "1465873a3dfdaa8ae7cb14b4383657caab0b3e8a0aa9ae8e04b044854c8dfce2"
 dependencies = [
  "crossbeam-deque",
  "crossbeam-utils",

Cargo.toml

@@ -2,7 +2,13 @@
 members = ["day_*"]
 resolver = "2"
 
+[workspace.package]
+name = "advent_of_code_2023"
+version = "1.0.0"
+edition = "2021"
+rust-version = "1.70.0"
+
 [workspace.dependencies]
-rayon = { version = "=1.8.0" }
+rayon = { version = "=1.8.1" }
 indicatif = { version = "=0.17.7", features = ["rayon"] }
 array-init = { version = "=2.1.0" }

LICENSE

@@ -1,4 +1,4 @@
-MIT License
+# MIT License
 
 Copyright (c) Théo LUDWIG
 

README.md

@@ -2,14 +2,29 @@
 
 ## About
 
-This repository contains my solutions for the [Advent of Code 2023](https://adventofcode.com/2023) challenges implemented in the [Rust Programming Language](https://www.rust-lang.org/) v1.74.0.
+This repository contains my solutions for the [Advent of Code 2023](https://adventofcode.com/2023) challenges implemented in the [Rust Programming Language](https://www.rust-lang.org/).
+
+## Getting Started
+
+### Prerequisites
+
+The current Minimum Supported [Rust](https://www.rust-lang.org/) Version (MSRV) is **1.70.0** (determined thanks to [cargo-msrv](https://crates.io/crates/cargo-msrv)).
+
+The project is **tested** against the following Rust versions:
+- **Minimum Supported Rust Version (MSRV): v1.70.0**
+- **Latest Stable Version**
+
+### Usage
 
 ```sh
-# Run the tests
-cargo test
-
 # Run a specific day's challenge (e.g. Day 1)
 cargo run --package day_1
+
+# Build, Lint, and Test
+cargo build
+cargo test
+cargo clippy --verbose -- -D warnings
+cargo fmt -- --check
 ```
 
 ## License

day_1/Cargo.toml

@@ -1,6 +1,7 @@
 [package]
 name = "day_1"
-version = "1.0.0"
+version.workspace = true
-edition = "2021"
+edition.workspace = true
+rust-version.workspace = true
 
 [dependencies]

day_2/Cargo.toml

@@ -1,6 +1,7 @@
 [package]
 name = "day_2"
-version = "1.0.0"
+version.workspace = true
-edition = "2021"
+edition.workspace = true
+rust-version.workspace = true
 
 [dependencies]

day_3/Cargo.toml

@@ -1,6 +1,7 @@
 [package]
 name = "day_3"
-version = "1.0.0"
+version.workspace = true
-edition = "2021"
+edition.workspace = true
+rust-version.workspace = true
 
 [dependencies]

day_4/Cargo.toml

@@ -1,6 +1,7 @@
 [package]
 name = "day_4"
-version = "1.0.0"
+version.workspace = true
-edition = "2021"
+edition.workspace = true
+rust-version.workspace = true
 
 [dependencies]

day_5/Cargo.toml

@@ -1,7 +1,8 @@
 [package]
 name = "day_5"
-version = "1.0.0"
+version.workspace = true
-edition = "2021"
+edition.workspace = true
+rust-version.workspace = true
 
 [dependencies]
 rayon = { workspace = true }

day_6/Cargo.toml

@@ -1,7 +1,8 @@
 [package]
 name = "day_6"
-version = "1.0.0"
+version.workspace = true
-edition = "2021"
+edition.workspace = true
+rust-version.workspace = true
 
 [dependencies]
 rayon = { workspace = true }

day_7/Cargo.toml

@@ -1,7 +1,8 @@
 [package]
 name = "day_7"
-version = "1.0.0"
+version.workspace = true
-edition = "2021"
+edition.workspace = true
+rust-version.workspace = true
 
 [dependencies]
 array-init = { workspace = true }