Skip to content

Add changelog newsfragment for path traversal shortest_paths_only (#1119)#1125

Merged
iddocohen merged 1 commit into
stablefrom
ic-changelog-1119-path-traversal-shortest-paths
Jul 2, 2026
Merged

Add changelog newsfragment for path traversal shortest_paths_only (#1119)#1125
iddocohen merged 1 commit into
stablefrom
ic-changelog-1119-path-traversal-shortest-paths

Conversation

@iddocohen

@iddocohen iddocohen commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

What

Adds the missing changelog newsfragment (changelog/1119.added.md) for the changes that landed in #1119 but were merged without a towncrier fragment.

#1119 added:

  • a shortest_paths_only parameter to traverse_paths() (async + sync) — set False to return all loopless paths instead of only the shortest one(s), matching the shortest_paths_only already exposed on reachable_nodes()
  • parsing of truncated_at_depth on PathTraversalResult

These were already present in stable (implementation + tests) but absent from 1.22.0's changelog, so the release notes drifted from the code. This fragment closes that gap so the entry is generated on the next release (e.g. 1.22.1).

Why

Without shortest_paths_only, path traversal could only ever return the shortest path(s); callers needing exhaustive/all-paths mode had to bypass the SDK. The feature shipped in #1119 but the newsfragment was forgotten, so stable has undocumented behaviour relative to the last release.

Notes

  • Code-only change is a single changelog fragment; no source or test changes needed — the feature and its unit tests already exist in stable.
  • Rendered draft verified with towncrier build --draft.

Summary by cubic

Adds the missing Towncrier changelog fragment so release notes document recent path traversal features and match stable. No source or tests changed.

  • New Features
    • shortest_paths_only on InfrahubClient.traverse_paths() (async and sync). Set False to return all loopless paths up to max_paths; default is None (defer to server).
    • PathTraversalResult now parses truncated_at_depth to indicate a search stopped at max_depth (or None if it finished).

Written for commit 574c875. Summary will update on new commits.

Review in cubic

@iddocohen iddocohen marked this pull request as ready for review July 2, 2026 13:23
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying infrahub-sdk-python with  Cloudflare Pages  Cloudflare Pages

Latest commit: 574c875
Status: ✅  Deploy successful!
Preview URL: https://7263cfe1.infrahub-sdk-python.pages.dev
Branch Preview URL: https://ic-changelog-1119-path-trave.infrahub-sdk-python.pages.dev

View logs

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Re-trigger cubic

@iddocohen iddocohen merged commit fedde45 into stable Jul 2, 2026
15 checks passed
@iddocohen iddocohen deleted the ic-changelog-1119-path-traversal-shortest-paths branch July 2, 2026 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants