From 734541ecc280053518860cd7f30d165a58880292 Mon Sep 17 00:00:00 2001 From: Mossa Date: Fri, 27 Feb 2026 09:07:58 +0100 Subject: [PATCH 1/3] wp: initial audit log spec --- spec/audit.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 spec/audit.md diff --git a/spec/audit.md b/spec/audit.md new file mode 100644 index 0000000..403a082 --- /dev/null +++ b/spec/audit.md @@ -0,0 +1,32 @@ +# `dvs audit` + +Goal: Provide a repository wide log of dvs tracked files. + +## CLI + +The option to return `--json` must be present. + +```sh +$ dvs audit +[Date] [User] [+{files} -{files}] [Message] +``` + +```sh +$ dvs audit --since +``` + +## R + +Signature: + +```r +dvs_audit <- function() +``` + +```r +dvs_audit() +``` + +```r +dvs_audit(since = NULL) +``` From fe81c58ca6cf3208510a906ab7a2f2cd9dbf6620 Mon Sep 17 00:00:00 2001 From: Mossa Date: Fri, 27 Feb 2026 13:38:00 +0100 Subject: [PATCH 2/3] added a pitch for `dvs audit` --- spec/audit.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/spec/audit.md b/spec/audit.md index 403a082..a57784d 100644 --- a/spec/audit.md +++ b/spec/audit.md @@ -2,10 +2,33 @@ Goal: Provide a repository wide log of dvs tracked files. +While the command `dvs audit` is on a repository, the audit log resides on the backend, and can contain miscellaneous information. + ## CLI The option to return `--json` must be present. +```sh +dvs audit log + +Usage: + dvs audit [PATHS] [OPTIONS] + +Paths: + Optional paths to files and directories for which to retrieve dvs repository events. + +Options: + --glob glob expression describing which files and folders to retrieve dvs events for + --filter-added retrieve audit log of the added files + --filter-deleted retrieve audit log of the deleted files + --filter-updated retrieve audit log of the updated (added multiple times) files + --events= which dvs events to retrieve + --invert invert the selection in `--filter-*`/`--events` + --since retrieve dvs events since this date. + -h, --help + +``` + ```sh $ dvs audit [Date] [User] [+{files} -{files}] [Message] @@ -20,7 +43,12 @@ $ dvs audit --since Signature: ```r -dvs_audit <- function() +dvs_audit <- function( + paths = c(), # optional, filters the audit log to the files/directories shown + glob = c(), # optional, glob expression representing `paths` + filter = c(), # optional, which dvs-event should be shown? + invert = FALSE, # opposite of selection in `filter` +) ``` ```r From 32a3a26dc9ce3f6ae6220a47b123ddfefc992383 Mon Sep 17 00:00:00 2001 From: Mossa Date: Fri, 27 Feb 2026 13:49:17 +0100 Subject: [PATCH 3/3] added users argument --- spec/audit.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/spec/audit.md b/spec/audit.md index a57784d..0b72b09 100644 --- a/spec/audit.md +++ b/spec/audit.md @@ -19,6 +19,7 @@ Paths: Options: --glob glob expression describing which files and folders to retrieve dvs events for + --users=[users..] list of users that are responsible for dvs events --filter-added retrieve audit log of the added files --filter-deleted retrieve audit log of the deleted files --filter-updated retrieve audit log of the updated (added multiple times) files @@ -46,6 +47,7 @@ Signature: dvs_audit <- function( paths = c(), # optional, filters the audit log to the files/directories shown glob = c(), # optional, glob expression representing `paths` + users = c(), # optional, list of users that caused dvs events of interest filter = c(), # optional, which dvs-event should be shown? invert = FALSE, # opposite of selection in `filter` )