Skip to content
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

Use split-explicit as default for large diffs #13

Merged
merged 1 commit into from
Jun 17, 2024
Merged

Use split-explicit as default for large diffs #13

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ You can do this by creating a configuration section in `pixi.toml` or `pyproject
```toml
# defaults
[tool.pixi-diff-to-markdown]
merge-dependencies = "no" # or "yes" when there are three or more environments / platforms
merge-dependencies = "no" # or "split-explicit" when there are three or more environments / platforms
hide = false
change-type-column = true
explicit-column = false
Expand All @@ -65,7 +65,7 @@ For a large amount of `environments` and `platforms`, it is recommended to merge
- `yes`: Merge all dependencies into one table and deduplicate them ([example](./tests/resources/diff-polarify/merge-yes_hide-False_change-type-True_explicit-False_package-type-False.md)).
- `split-explicit`: Merge all dependencies into one table and deduplicate them but split the table into one `explicit` and one `implicit` table ([example](./tests/resources/diff-polarify/merge-split-explicit_hide-False_change-type-True_explicit-False_package-type-False.md)).

The default is `no` when there are less than three environments / platforms and `yes` when there are three or more environments / platforms.
The default is `no` when there are less than three environments / platforms and `split-explicit` when there are three or more environments / platforms.

### `hide`

Expand Down
2 changes: 1 addition & 1 deletion pixi_diff_to_markdown/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ def main(
"explicit-column": explicit_column,
"merge-dependencies": merge_dependencies,
"hide-tables": hide_tables,
"inferred_merge_dependencies": MergeDependencies.yes
"inferred_merge_dependencies": MergeDependencies.split_explicit
if num_environments > 2
else MergeDependencies.no,
}
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "hatchling.build"

[project]
name = "pixi-diff-to-markdown"
version = "0.2.1"
version = "0.2.2"
description = "Tool for converting `pixi update` diffs to markdown"
readme = "README.md"
authors = [{ name = "Pavel Zwerschke", email = "pavelzw@gmail.com" }]
Expand Down