Skip to content

Update README.md #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #122

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,9 @@ The CLI now automatically detects repository information from your git environme
- **Committer information**: Git commit author details
- **Default branch status**: Determined from git repository and CI environment
- **Changed files**: Files modified in the current commit (for differential scanning)

> **Note on merge commits**:
> Standard merges (two parents) are supported.
> 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`.
### Default Branch Detection

The CLI uses intelligent default branch detection with the following priority:
Expand Down Expand Up @@ -400,6 +402,11 @@ The manifest archive feature is useful for:

> **Note**: The tar.gz archive preserves the original directory structure, making it easy to extract and examine the files in their proper context.

### Differential scan skipped on octopus merge

When your repo uses an **octopus merge** (3+ parents), the CLI may not detect all changed files.
This is expected Git behavior: the default diff only compares the merge result to the first parent.

## Development

This project uses `pyproject.toml` as the primary dependency specification.
Expand Down
Loading