You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Notes: captures stdout/stderr to a temporary log that is attached as a git note (skipped if empty) and merges `{run:{...}}` into the JSON trailer via `SHIPLOG_EXTRA_JSON`. `--dry-run` prints the command that would execute and exits without running it or writing a journal entry. See `docs/reference/json-schema.md` for the structured payload.
45
+
- Notes: captures stdout/stderr to a temporary log that is attached as a git note (skipped if empty) and merges `{run:{...}}` into the JSON trailer via `SHIPLOG_EXTRA_JSON`. `--dry-run` prints the command that would execute and exits without running it or writing a journal entry. See `docs/features/run.md` for detailed behavior (preview output, exit codes, caveats) and `docs/reference/json-schema.md` for the structured payload.
`git shiplog run` wraps a shell command, captures its stdout/stderr, and records the execution as a Shiplog journal entry. The command output is saved as a git note, and the structured trailer gains a `run` payload describing the invocation. Use `--dry-run` to preview what would happen without executing the command or writing an entry.
4
+
`git shiplog run` wraps a shell command, captures its stdout/stderr, and records the execution as a Shiplog journal entry. Output is saved as a git note, and the structured trailer gains a `run` payload describing the invocation. Use `--dry-run` to preview the command, status, and trailer fields without executing the command or mutating the journal.
5
5
6
6
## Usage
7
7
```bash
8
+
# Standard execution (writes to the journal once the wrapped command runs)
8
9
git shiplog run --service deploy --reason "Smoke test" -- env printf hi
10
+
11
+
# Dry run: rehearse the invocation without executing or writing an entry
9
12
git shiplog run --dry-run --service deploy --reason "Smoke test" -- env printf hi
10
13
```
11
14
12
-
-`--service` is required in non-interactive mode (and highly recommended in general).
13
-
- Place the command to execute after `--`. All arguments are preserved and logged.
- Exits with status `0` when the dry-run invocation is well formed. Invalid flags, missing `--`, or unknown subcommands surface the same non-zero exit codes as the standard command.
23
+
- Deterministic output keeps automation safe while rehearsing deploy playbooks.
15
24
16
-
## Behavior
17
-
- Captures stdout/stderr to a temporary file. When not in boring mode, output is also streamed to your terminal via `tee`.
18
-
-`--dry-run` prints the wrapped command, returns exit code 0, and skips execution, journal writes, and log attachment.
19
-
- Sets `SHIPLOG_BORING=1` and `SHIPLOG_ASSUME_YES=1` while calling `git shiplog write` so no prompts fire.
20
-
- Populates `SHIPLOG_EXTRA_JSON` with:
25
+
## Behavior (Standard Runs)
26
+
- Captures stdout/stderr to a temporary file. When Bosun is available, output streams through a live preview while still being recorded for notes.
27
+
- Sets `SHIPLOG_BORING=1` and `SHIPLOG_ASSUME_YES=1` while delegating to `git shiplog write`, ensuring prompts are bypassed.
28
+
- Populates `SHIPLOG_EXTRA_JSON` with a `run` block such as:
21
29
```json
22
30
{
23
31
"run": {
@@ -32,21 +40,34 @@ git shiplog run --dry-run --service deploy --reason "Smoke test" -- env printf h
32
40
}
33
41
}
34
42
```
35
-
- Attaches the captured log as a git note under `refs/_shiplog/notes/logs` when the entry is written successfully.
36
-
- Returns the wrapped command’s exit code so it can be chained in scripts or CI pipelines.
43
+
- Attaches the captured log as a git note under `refs/_shiplog/notes/logs` when an entry is written successfully.
44
+
- Returns the wrapped command’s exit code so it can chain cleanly in scripts or CI pipelines.
45
+
46
+
## Exit Codes
47
+
- Dry run
48
+
-`0` when the preview succeeds.
49
+
- Non-zero for malformed invocations or validation errors.
50
+
- Standard run
51
+
- Mirrors the wrapped command’s exit status after the journal entry is recorded.
52
+
- Propagates Shiplog errors directly if the CLI fails before wrapping the command.
37
53
38
54
## Options
39
-
-`--dry-run` — Print the command that would execute, then exit without running it or writing a journal entry.
55
+
-`--dry-run` — Preview the command and metadata without executing or writing an entry.
40
56
-`--env <name>` — Target journal environment (defaults to `SHIPLOG_ENV` or `prod`).
41
57
-`--service <name>` — Service/component; required when prompts are disabled.
Copy file name to clipboardExpand all lines: docs/releases/v0.2.1.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,14 +4,16 @@
4
4
5
5
> [!information]
6
6
> In my haste to release `v0.2.0`, I neglected to add a `--dry-run` mode to `git shiplog run`. This rapid follow-up is to address this oversight.
7
-
8
-
This maintenance release adds a safe way to rehearse Shiplog runs while keeping the journal untouched.
7
+
8
+
**Release type:** Feature release
9
+
10
+
This feature release introduces the new `--dry-run` flag for `git shiplog run`, letting teams rehearse deployments safely without mutating the journal.
9
11
10
12
## ⚓ Highlight
11
13
12
14
### 🧪 Dry-Run Preview — `git shiplog run --dry-run`
13
15
14
-
Plan a maintenance step or incident response without firing the actual command. The new `--dry-run` flag formats the invocation, shows what would be recorded, and exits 0 without executing or writing to the journal.
16
+
Plan a maintenance step or incident response without firing the actual command. The new `--dry-run` flag formats the invocation, previews exactly what would be logged, and exits 0 without executing or touching the journal.
15
17
16
18
```bash
17
19
$ git shiplog run \
@@ -23,8 +25,8 @@ $ git shiplog run \
23
25
```
24
26
25
27
- No command side effects and no Git notes are created.
26
-
- Bosun-enabled terminals receive a styled “Dry Run” card; otherwise the CLI prints the same message once.
27
-
-The exit code is always 0, keeping rehearsals script-friendly.
28
+
- Bosun-enabled terminals (see the [Bosun CLI styling tool docs](../bosun/overview.md)) receive a styled “Dry Run” card; otherwise the CLI prints the same message once.
29
+
-Successful dry runs exit 0 for scripting ease; malformed input or unknown commands still return non-zero.
0 commit comments