Fixes to packages & GitHub Action

Signed-off-by: stavrosvl7 <stavrosvl7@gmail.com>

Author: svlachakis

.github/workflows/docs.yml

@@ -31,7 +31,7 @@ jobs:
       # just remove katex-header.html at the root and RUSTDOCFLAGS here
       # TODO(template) update the crate name
       - name: Build documentation
-        run: RUSTDOCFLAGS="--html-in-header katex-header.html" cargo doc --no-deps -p template-crate
+        run: RUSTDOCFLAGS="--html-in-header katex-header.html" cargo doc --no-deps -p template_crate
 
       - name: Remove lock file
         run: rm target/doc/.lock

.github/workflows/semver-checks.yml

@@ -6,19 +6,42 @@ on:
   pull_request:
     branches: [ "main" ]
 
+# Limit permissions to minimum required
+permissions:
+  contents: read
+
 env:
   CARGO_TERM_COLOR: always
   CARGO_INCREMENTAL: 0
 
 jobs:
   semver:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
     steps:
     - uses: actions/checkout@v4
       with:
         # cargo-semver-checks needs the full git history to compare versions
         fetch-depth: 0
 
+    - name: Install Rust toolchain
+      uses: dtolnay/rust-toolchain@stable
+    
+    - name: Cache cargo registry
+      uses: actions/cache@v4
+      with:
+        path: |
+          ~/.cargo/registry/index/
+          ~/.cargo/registry/cache/
+          ~/.cargo/git/db/
+        key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-cargo-
+    
     - name: Check semver compatibility
-      uses: obi1kenobi/cargo-semver-checks-action@v2
-
+      # Pinned to v2.8: https://github.com/obi1kenobi/cargo-semver-checks-action/releases/tag/v2.8
+      uses: obi1kenobi/cargo-semver-checks-action@5b298c9520f7096a4683c0bd981a7ac5a7e249ae
+      with:
+        # Optional: customize behavior
+        verbose: true

CONTRIBUTING.md

@@ -30,8 +30,8 @@ After cloning the repository, follow the instructions below to run the documenta
 cargo doc
 ```
 
-Docs for `TODO(template) template-crate`:
+Docs for `TODO(template) template_crate`:
 
 ```sh
-RUSTDOCFLAGS="--html-in-header katex-header.html" cargo doc --no-deps -p template-crate --open
+RUSTDOCFLAGS="--html-in-header katex-header.html" cargo doc --no-deps -p template_crate --open
 ```

Cargo.toml

@@ -1,9 +1,9 @@
 
 # TODO(template) update for the crate name
 [workspace]
-members = ["examples", "template-crate"]
+members = ["examples", "template_crate"]
 resolver = "2"
-default-members = ["template-crate"]
+default-members = ["template_crate"]
 
 [workspace.package]
 version = "0.1.0"

examples/Cargo.toml

@@ -8,4 +8,4 @@ license.workspace = true
 
 [dependencies]
 # TODO(template) update the crate name
-mycrate = { path = "../mycrate" }
+template_crate = { path = "../template_crate" }

examples/README.md

@@ -9,4 +9,4 @@ To run an example
 cargo run -p examples --bin addition
 ```
 
-* `addition` - shows how to add two bounded integers with the [`mycrate`](../mycrate/) library.
+* `addition` - shows how to add two bounded integers with the [`template_crate`](../template_crate/) library.

examples/src/bin/addition.rs

@@ -1,5 +1,5 @@
 // TODO(template) - remove/change the code below and rename the example
-use mycrate::add_small_integers;
+use template_crate::add_small_integers;
 
 fn main() {
     println!("{:?}", add_small_integers(6, 8));

template-crate/Cargo.toml template_crate/Cargo.tomltemplate-crate/Cargo.toml renamed to template_crate/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 # TODO(template) rename
-name = "template-crate"
+name = "template_crate"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true