chore: general improvements

Author: jd-apprentice

.github/workflows/release.yml

@@ -1,21 +1,22 @@
 name: test, analyze and publish
 
 on:
-    workflow_run:
-        workflows: ["Quality Gate"]
-        types:
-            - completed
-    workflow_dispatch:
+  workflow_run:
+    workflows: ["Quality Gate"]
+    types:
+      - completed
+  workflow_dispatch:
 
 permissions:
   contents: write
 
 jobs:
   release:
     uses: jd-apprentice/jd-workflows/.github/workflows/release.yml@main
-    if: github.ref == 'refs/heads/main'
+    if: ${{ github.ref == 'refs/heads/master' && github.event.workflow_run.conclusion == 'success' }}
     with:
       name: release
       runs_on: ubuntu-latest
+      release_notes: true
     secrets:
-      gh_token: ${{ secrets.GITHUB_TOKEN }}
+      gh_token: ${{ secrets.GITHUB_TOKEN }}

Cargo.toml.liquid

@@ -1,7 +1,12 @@
 [package]
 name = "{{ package_name }}"
+description = "{{ package_description }}"
 version = "0.1.0"
 edition = "2021"
+documentation = ""
+repository = ""
+categories = ["command-line-utilities"]
+keywords = ["cli"]
 
 {% if license == "MIT" %}
 license = "MIT"
@@ -15,10 +20,10 @@ license = "MIT OR Apache-2.0"
 
 [dependencies]
 {% if dotenv == true %}
-dotenv = "0.15.0"
+dotenvy = "0.15.7"
 {% endif %}
 
 {% if sentry == true %}
 sentry = "0.34.0"
 tokio = { version = "1", features = ["full"] }
-{% endif %}
+{% endif %}

Makefile.liquid

@@ -6,7 +6,7 @@ dev:
 build: src/main.rs
 	cargo build --release --bin {{ package_name }}
 
-docker: 
+docker:
 	docker build -f docker/Dockerfile -t rust_template .
 
 compose:
@@ -16,9 +16,15 @@ test:
 	cargo test
 
 lint:
-	cargo clippy -- -D warnings
- 
+	cargo clippy --all-targets --all-features
+
+lint-fix:
+	cargo clippy --all-targets --all-features --fix --allow-dirty
+
 format:
 	cargo fmt --all --check
 
-.PHONY: build docker test lint format compose
+format-fix:
+	cargo fmt --all
+
+.PHONY: build docker test lint format compose

cargo-generate.toml

@@ -2,12 +2,16 @@
 
 [template]
 cargo_generate_version = ">=0.22.0"
-exclude = ["assets"]
+exclude = ["assets/*, Cargo.toml"]
 
 [placeholders.package_name]
 type = "string"
 prompt = "What is the name of the package?"
 
+[placeholders.package_description]
+type = "string"
+propt = "Enter a project description"
+
 [placeholders.license]
 type = "string"
 prompt = "What licenses will the project have?"
@@ -47,21 +51,25 @@ default = false
 ## License
 
 [conditional.'license != "MIT" && license != "all"']
-ignore = ["LICENSE-MIT"]
+exclude = ["LICENSE-MIT"]
 
 [conditional.'license != "APACHE" && license != "all"']
-ignore = ["LICENSE-APACHE"]
+exclude = ["LICENSE-APACHE"]
 
 ## Workflows
 [conditional.'github_release == false']
-ignore = [".github/workflows/release.yaml"]
+exclude = [".github/workflows/release.yaml"]
 
 ## Dependencies
 [conditional.'dotenv == false']
-ignore = [".env.example"]
+exclude = [".env.example"]
 
 [conditional. 'sentry == true']
 type = "string"
 name = "sentry_dsn"
 prompt = "What is your sentry dsn?"
-default = "https://examplePublicKey@o0.ingest.sentry.io/0"
+default = "https://examplePublicKey@o0.ingest.sentry.io/0"
+
+## Files
+[conditional. 'sentry == false']
+exclude = ["./src/functions.rs"]

rust-toolchain.toml.liquid

@@ -1,4 +1,4 @@
 [toolchain]
-channel = {{ toolchain }}
+channel = "{{ toolchain }}"
 profile = "default"
-components = ["clippy", "rustfmt"]
+components = ["clippy", "rustfmt"]

src/functions.rs

@@ -0,0 +1,20 @@
+/// # Panics
+/// Will panic if `SENTRY_DSN` is not set in the .env file
+#[inline]
+pub fn load_sentry() {
+    dotenvy::dotenv().unwrap_or_else(|_| {
+        panic!("Missing .env file");
+    });
+
+    let sentry_dns = env::var("SENTRY_DSN").unwrap_or_else(|_| {
+        panic!("Missing SENTRY_DSN environment variable");
+    });
+
+    let _guard = sentry::init((
+        sentry_dns,
+        sentry::ClientOptions {
+            release: sentry::release_name!(),
+            ..Default::default()
+        },
+    ));
+}

src/lib.rs renamed to src/lib.rs.liquid

@@ -1,3 +1,8 @@
+{% if sentry == true %}
+mod functions;
+pub use functions::load_sentry;
+{% endif %}
+
 #[derive(Default)]
 pub struct MathOperation {
     pub operator: String,

src/main.rs

@@ -1,40 +1,17 @@
+use {{ project_name }}::{load_sentry};
 use std::thread::sleep;
 
-{% if dotenv == true %}
-use dotenv;
-
-dotenv::dotenv().ok();
-{% endif %}
-
 #[path = "1_module/tests/add_sub.rs"]
 mod add_sub;
 #[path = "2_module/tests/mul_div.rs"]
 mod mul_div;
 
 fn main() {
-
     {% if sentry == true %}
-    const _config: sentry::ClientInitGuard = sentry::init(({{ sentry_dsn }}, sentry::ClientOptions {
-        release: sentry::release_name!(),
-        ..Default::default()
-    }));
+    load_sentry();
     {% endif %}
-
     const SLEEP_MESSAGE: &str = "Sleep forever...";
     const HELLO_SENTRY: &str = "Hello, sentry!";
     println!("{}", SLEEP_MESSAGE);
     sleep(std::time::Duration::from_millis(f64::INFINITY as u64));
-
-    {% if sentry == true %}
-    tokio::runtime::Builder::new_multi_thread()
-            .enable_all()
-            .build()
-            .unwrap()
-            .block_on(async {
-                let _ = sentry::capture_message(HELLO_SENTRY, sentry::Level::Info);
-                println!("{}", HELLO_SENTRY);
-            });
-    {% endif %}
 }
-
-