Skip to content

Commit ec36f08

Browse files
dachi-devdacoburn
andauthored
Update README.md (#122)
Co-authored-by: Douglas <douglas@socket.dev>
1 parent 1ab83ab commit ec36f08

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,9 @@ The CLI now automatically detects repository information from your git environme
243243
- **Committer information**: Git commit author details
244244
- **Default branch status**: Determined from git repository and CI environment
245245
- **Changed files**: Files modified in the current commit (for differential scanning)
246-
246+
> **Note on merge commits**:
247+
> Standard merges (two parents) are supported.
248+
> For *octopus merges* (three or more parents), Git only reports changes relative to the first parent. This can lead to incomplete or empty file lists if changes only exist relative to other parents. In these cases, differential scanning may be skipped. To ensure coverage, use `--ignore-commit-files` to force a full scan or specify files explicitly with `--files`.
247249
### Default Branch Detection
248250
249251
The CLI uses intelligent default branch detection with the following priority:
@@ -428,6 +430,11 @@ The manifest archive feature is useful for:
428430
429431
> **Note**: The tar.gz archive preserves the original directory structure, making it easy to extract and examine the files in their proper context.
430432
433+
### Differential scan skipped on octopus merge
434+
435+
When your repo uses an **octopus merge** (3+ parents), the CLI may not detect all changed files.
436+
This is expected Git behavior: the default diff only compares the merge result to the first parent.
437+
431438
## Development
432439
433440
This project uses `pyproject.toml` as the primary dependency specification.

0 commit comments

Comments
 (0)