Add changelog newsfragment for path traversal shortest_paths_only (#1119)#1125
Merged
Merged
Conversation
Deploying infrahub-sdk-python with
|
| 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 |
ogenstad
approved these changes
Jul 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
shortest_paths_onlyparameter totraverse_paths()(async + sync) — setFalseto return all loopless paths instead of only the shortest one(s), matching theshortest_paths_onlyalready exposed onreachable_nodes()truncated_at_depthonPathTraversalResultThese were already present in
stable(implementation + tests) but absent from1.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, sostablehas undocumented behaviour relative to the last release.Notes
stable.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.shortest_paths_onlyonInfrahubClient.traverse_paths()(async and sync). SetFalseto return all loopless paths up tomax_paths; default isNone(defer to server).PathTraversalResultnow parsestruncated_at_depthto indicate a search stopped atmax_depth(orNoneif it finished).Written for commit 574c875. Summary will update on new commits.