diff --git a/.github/workflows/audit.yml b/.github/workflows/audit.yml new file mode 100644 index 0000000..ce0f227 --- /dev/null +++ b/.github/workflows/audit.yml @@ -0,0 +1,34 @@ +# This runs `cargo audit` on all dependencies (only if Cargo deps changed) + +name: Audit + +on: + push: + paths: + - '**/Cargo.toml' + - '**/Cargo.lock' + +env: + CARGO_TERM_COLOR: always + +jobs: + audit: + + runs-on: ubuntu-latest + + steps: + - name: Cache + uses: actions/cache@v3.2.3 + with: + path: | + ~/.cargo + target + key: audit + - uses: actions/checkout@v4 + with: + submodules: recursive + - name: Install dependencies + run: cargo install cargo-audit --locked + - name: Audit + run: cargo audit + diff --git a/Cargo.toml b/Cargo.toml index a2afd02..8833354 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "long-tasks-manager-rs" +name = "task-tracker-rs" version = "0.1.0" edition = "2021" diff --git a/NOTES.md b/NOTES.md index bf38fd1..5714911 100644 --- a/NOTES.md +++ b/NOTES.md @@ -1,4 +1,4 @@ -# Notes of long-tasks-manager-rs +# Notes of task-tracker-rs ## Crates to use diff --git a/OBJECTIVES.md b/OBJECTIVES.md index bfbab9f..686717f 100644 --- a/OBJECTIVES.md +++ b/OBJECTIVES.md @@ -1,4 +1,4 @@ -# OBJECTIVES of long-tasks-manager +# OBJECTIVES of task-tracker ## Serve a task manager API The purpose is to serve an API to manage status of long running tasks. ### CRUD diff --git a/README.md b/README.md index c79c2e1..786602f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# long-tasks-manager-rs +# task-tracker-rs Restfull API backend to manage status of long running tasks. ## Description -long-tasks-manager-rs is a backend service that manage only the status, not the tasks themselves. +task-tracker-rs is a backend service that manage only the status, not the tasks themselves. A service can use it to create a task, update the progress and status of completion. An id to track the task will be given at creation, allowing to view or update it. ## Features diff --git a/TODO.md b/TODO.md index af966c1..6698e23 100644 --- a/TODO.md +++ b/TODO.md @@ -1,4 +1,4 @@ -# TODO long-tasks-manager +# TODO task-tracker - [ ] way to configure admin key and listening port at startup (env variables) - [ ] struct to store task data diff --git a/USECASE.md b/USECASE.md index 8636b6e..83436c2 100644 --- a/USECASE.md +++ b/USECASE.md @@ -1,4 +1,4 @@ -# API of long-tasks-manager +# API of task-tracker long-task-manager (LTM) scenario of usage: