CI/CD optimization

.github/workflows/.checks.yml

@@ -2,23 +2,13 @@ name: Checks
 
 on: { workflow_call: {} }
 
-permissions: {
-  contents: read,
-  actions: write
-}
-
-env:
-  CI: "true"
-  RUST_BACKTRACE: "1"
-  CARGO_TERM_COLOR: "always"
-
 jobs:
   fmt:
     runs-on: ${{ vars.RUNS_ON }}
     steps:
       - uses: actions/checkout@v4
       - name: Run fmt
-        uses: ./.github/actions/taskfile
+        uses: soltiHQ/actions/taskfile@main
         with: { command: cargo/fmt }
 
   test:
@@ -32,7 +22,7 @@ jobs:
         with: { job_name: test }
 
       - name: Run Job
-        uses: ./.github/actions/taskfile
+        uses: soltiHQ/actions/taskfile@main
         with: { command: cargo/test }
 
       - name: Put Cache
@@ -51,7 +41,7 @@ jobs:
         with: { job_name: clippy }
 
       - name: Run Job
-        uses: ./.github/actions/taskfile
+        uses: soltiHQ/actions/taskfile@main
         with: { command: cargo/clippy }
 
       - name: Put Cache

.github/workflows/.docs.yml

@@ -0,0 +1,12 @@
+name: Docs
+
+on: { workflow_call: {} }
+
+jobs:
+  docs:
+    runs-on: ${{ vars.RUNS_ON }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run docs gen
+        uses: soltiHQ/actions/taskfile@main
+        with: { command: cargo/docs }

.github/workflows/pr.yml

@@ -0,0 +1,27 @@
+name: Pr
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+
+concurrency:
+  group: pr-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions: {
+  contents: read,
+  actions: write
+}
+
+jobs:
+  docs:
+    name: Docs
+    uses: ./.github/workflows/.docs.yml
+
+  pr-check:
+    name: Pr Check
+    needs: docs
+    runs-on: ${{ vars.RUNS_ON }}
+    steps:
+      - name: All checks passed
+        run: echo "All Pr checks completed successfully!"

Taskfile.yml

@@ -4,7 +4,7 @@ vars:
   git_root:
     sh: git rev-parse --show-toplevel
 
-  rust_version: "1.90"
+  rust_version: "1.90.0"
   cache_dir: ".cache"
 
 tasks:
@@ -59,14 +59,16 @@ tasks:
       - cmd: mkdir -p "{{.git_root}}/{{.cache_dir}}"
       - task: _docker/run
         vars:
-          IMAGE: "rust:{{.rust_version}}-slim"
+          IMAGE: "ghcr.io/soltihq/cargo-tools:{{.rust_version}}"
           CMD: "{{.CMD}}"
           MOUNT_DIR: "."
           VOLUMES:
             - "{{.git_root}}/{{.cache_dir}}:/tmp/{{.cache_dir}}"
           ENVS:
             - "CARGO_TARGET_DIR=/tmp/{{.cache_dir}}/target"
             - "CARGO_HOME=/tmp/{{.cache_dir}}/cargo"
+            - "RUSTUP_TOOLCHAIN={{.rust_version}}"
+            - "RUSTUP_NO_UPDATE_CHECK=1"
             - "CARGO_INCREMENTAL=0"
 
   # ================================================#
@@ -78,18 +80,28 @@ tasks:
     cmds:
       - task: _cargo/tool
         vars:
-          CMD: "rustup component add rustfmt && cargo fmt --check --verbose"
+          CMD: "fmt --check --verbose"
 
   cargo/clippy:
     desc: Run 'cargo clippy'.
     cmds:
       - task: _cargo/tool
         vars:
-          CMD: "rustup component add clippy && cargo clippy --all --all-features -- -D warnings"
+          CMD: "clippy --all --all-features -- -D warnings"
 
   cargo/test:
     desc: Run 'cargo test'.
     cmds:
       - task: _cargo/tool
         vars:
-          CMD: "cargo test --all --all-features"
+          CMD: "test --all --all-features"
+
+  cargo/docs:
+    desc: Run 'rustdoc'.
+    cmds:
+      - task: _cargo/tool
+        vars:
+          CMD: >-
+            +nightly rustdoc --lib -Zrustdoc-map --features "logging controller"
+            -Zunstable-options -Zrustdoc-scrape-examples
+            --config 'build.rustdocflags=["--cfg","docsrs","-Z","unstable-options","--cap-lints","warn"]'

src/core/builder.rs

@@ -46,7 +46,6 @@ impl SupervisorBuilder {
     ///
     /// Requires the `controller` feature flag.
     #[cfg(feature = "controller")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "controller")))]
     pub fn with_controller(mut self, config: crate::controller::ControllerConfig) -> Self {
         self.controller_config = Some(config);
         self

src/core/supervisor.rs

@@ -263,7 +263,6 @@ impl Supervisor {
     ///
     /// Requires the `controller` feature flag.
     #[cfg(feature = "controller")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "controller")))]
     pub async fn submit(
         &self,
         spec: crate::controller::ControllerSpec,
@@ -280,7 +279,6 @@ impl Supervisor {
     ///
     /// Requires the `controller` feature flag.
     #[cfg(feature = "controller")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "controller")))]
     pub fn try_submit(
         &self,
         spec: crate::controller::ControllerSpec,

src/lib.rs

@@ -1,6 +1,3 @@
-#![doc(html_no_source)]
-#![cfg_attr(docsrs, feature(doc_cfg))]
-
 //! # taskvisor
 //!
 //! **Taskvisor** is a lightweight task orchestration library for Rust.
@@ -13,8 +10,8 @@
 //! ### Overview
 //! ```text
 //!     ┌──────────────┐   ┌──────────────┐   ┌──────────────┐
-//!     │   TaskSpec   │ … │   TaskSpec   │ … │   TaskSpec   │
-//!     │(user task #1)│ … │(user task #2)│ … │(user task #3)│
+//!     │   TaskSpec   │   │   TaskSpec   │   │   TaskSpec   │
+//!     │(user task #1)│   │(user task #2)│   │(user task #3)│
 //!     └──────┬───────┘   └──────┬───────┘   └──────┬───────┘
 //!            ▼                  ▼                  ▼
 //! ┌───────────────────────────────────────────────────────────────────┐
@@ -40,7 +37,7 @@
 //! ┌───────────────────────────────────────────────────────────────────┐
 //! │                        Bus (broadcast channel)                    │
 //! │                  (capacity: Config::bus_capacity)                 │
-//! └─────────────────────────────────┬─────────────────────────────────┘
+//!└─────────────────────────────────┬─────────────────────────────────┘
 //!                                   ▼
 //!                       ┌────────────────────────┐
 //!                       │  subscriber_listener   │
@@ -49,11 +46,9 @@
 //!                           ▼                ▼
 //!                    AliveTracker     SubscriberSet
 //!                  (sequence-based)   (per-sub queues)
-//!                                            │
 //!                                  ┌─────────┼─────────┐
 //!                                  ▼         ▼         ▼
 //!                                  worker1  worker2  workerN
-//!                                  │         │         │
 //!                                  ▼         ▼         ▼
 //!                             sub1.on   sub2.on   subN.on
 //!                              _event()  _event()  _event()
@@ -70,12 +65,12 @@
 //!   ├─► run_once(task, timeout, attempt)
 //!   │       │
 //!   │       ├─ Ok  ──► publish TaskStopped
-//!   │       │          ├─ RestartPolicy::Never     → ActorExhausted, exit
-//!   │       │          ├─ RestartPolicy::OnFailure → ActorExhausted, exit
-//!   │       │          └─ RestartPolicy::Always    → reset delay, continue
+//!   │       │          ├─ RestartPolicy::Never     ─► ActorExhausted, exit
+//!   │       │          ├─ RestartPolicy::OnFailure ─► ActorExhausted, exit
+//!   │       │          └─ RestartPolicy::Always    ─► reset delay, continue
 //!   │       │
 //!   │       └─ Err ──► publish TaskFailed{ task, error, attempt }
-//!   │                  ├─ RestartPolicy::Never     → ActorExhausted, exit
+//!   │                  ├─ RestartPolicy::Never     ─► ActorExhausted, exit
 //!   │                  └─ RestartPolicy::OnFailure/Always:
 //!   │                       ├─ compute delay = backoff.next(prev_delay)
 //!   │                       ├─ publish BackoffScheduled{ delay, attempt }
@@ -84,8 +79,8 @@
 //!   │
 //!   └─ exit conditions:
 //!        - runtime_token cancelled (OS signal or explicit remove)
-//!        - RestartPolicy forbids continuation → ActorExhausted
-//!        - Fatal error → ActorDead
+//!        - RestartPolicy forbids continuation ─► ActorExhausted
+//!        - Fatal error ─► ActorDead
 //!        - semaphore closed
 //! }
 //!