Standardize output columns pgr binaryBreadtFirstSearch

[cvvergara]

Fixes #2908 .

Changes proposed in this pull request:

• Standardizing pgr_binaryBreadthFirstSearch to one path result columns
• Updating NEWS and release notes about standardization

@pgRouting/admins

Summary by CodeRabbit

• New Features

  • Introduced new contraction algorithms and documentation, including pgr_contractionDeadEnd, pgr_contractionLinear, and experimental pgr_contractionHierarchies.
  • Added official documentation for pgr_degree and pgr_topologicalSort.
  • Expanded support for PostgreSQL versions 17 and 18 in CI workflows.

• Improvements

  • Standardized and enhanced documentation structure, indexing, and formatting across many functions and categories.
  • Promoted several functions and signatures to official status, notably in the 4.0.0 release.
  • Updated and clarified release notes and changelogs.
  • Improved installation and citation instructions in the README.

• Removals

  • Deprecated and removed documentation and references for obsolete or experimental features (e.g., alpha_shape, certain old signatures).
  • Deleted Transifex configuration and some legacy build scripts.

• Chores

  • Updated CI workflows for dependency management and compatibility.
  • Enhanced .gitignore to exclude editor and script files.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This pull request includes extensive updates to documentation, configuration files, CI workflows, and versioning for the pgRouting 4.0.0 release. Key changes involve major documentation restructuring, new and updated function documentation, workflow enhancements, expanded version matrices, and removal of deprecated or obsolete files. No code changes to public or exported entities are present.

Changes

File(s)	Change Summary
.github/workflows/*.yml	Updated CI workflows: added/removed dependencies, expanded PostgreSQL version matrix, improved repository setup, and updated trigger conditions.
.gitignore	Added .vscode, taptest.sh, and run.sh to ignored files.
.tx/config	Deleted Transifex localization configuration file.
CMakeLists.txt, configuration.conf	Updated project version to 4.0.0, minimum CMake version, and configuration for directories and features.
NEWS.md, README.md	Streamlined changelog for 4.0.0, added DOI badge, package manager instructions, and citation section.
ci/winnie/build_pgrouting.sh	Refactored environment variable handling, debugging, and test execution logic.
doc/CMakeLists.txt, doc/conf.py.in	Improved documentation build configuration, added Sphinx extensions, and updated substitutions.
doc/_static/page_history.js	Enhanced version tracking, link generation, and file mapping for documentation history.
doc/allpairs/*, doc/astar/*, doc/bdAstar/*, doc/bdDijkstra/*, doc/bellman_ford/*, doc/categories/*, doc/chinese/*, doc/circuits/*, doc/coloring/*, doc/components/*, doc/contraction/*, doc/dagShortestPath/*, doc/dijkstra/*, doc/driving_distance/*, doc/ksp/*, doc/lineGraph/*, doc/max_flow/*, doc/metrics/*, doc/mincut/*, doc/ordering/*, doc/pickDeliver/*	Extensive documentation restructuring: improved indexing, formatting, added/removed files, standardized output, and added new function docs (e.g., contraction, degree, topological sort).
doc/alpha_shape/*, doc/breadthFirstSearch/*	Removed documentation and CMake files for deprecated/removed features.
doc/contraction/pgr_contractionDeadEnd.rst, doc/contraction/pgr_contractionLinear.rst, doc/contraction/pgr_contractionHierarchies.rst, doc/metrics/pgr_degree.rst, doc/ordering/pgr_topologicalSort.rst	Added new documentation for proposed/experimental functions: contraction and degree calculation, topological sort.
Other doc/*/CMakeLists.txt	Updated lists of documentation files to reflect added/removed/renamed docs.

Sequence Diagram(s)

Omitted as changes are documentation, configuration, and workflow updates without new feature control flow.

Assessment against linked issues

Objective	Addressed	Explanation
Standardize output columns of pgr_binaryBreadthFirstSearch (#2908)	❓	No documentation or code changes for pgr_binaryBreadthFirstSearch are present in this PR; unclear if this objective is addressed.

Assessment against linked issues: Out-of-scope changes

Code Change	Explanation
Addition of new contraction and degree function documentation (e.g., doc/contraction/pgr_contractionDeadEnd.rst, doc/metrics/pgr_degree.rst)	These changes are unrelated to the objective of standardizing output columns for pgr_binaryBreadthFirstSearch in #2908.
Major restructuring and reformatting of documentation across many files	These broad documentation updates are not related to the specific objective in #2908.
CI workflow and configuration updates (e.g., .github/workflows/ubuntu.yml, .gitignore)	These are maintenance and infrastructure changes not tied to the stated objective.

Possibly related PRs

• pgRouting/pgrouting#2864: Related due to similar changes in NEWS.md focusing on release notes presentation.
• pgRouting/pgrouting#2893: Related as both PRs update CI workflows, including PostgreSQL version matrices and repository setup.
• pgRouting/pgrouting#2784: Related through changes in GitHub Actions workflows for dependency installation and test setup.

Suggested reviewers

• robe2

Poem

A rabbit hops through docs and code,
With version four, the stories flowed.
New functions bloom, old ones retire,
CI and badges climbing higher.
From contraction tales to degree delight,
This release is quite a sight!
🐇✨

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Commit Unit Tests in branch issue-2908-standardize-output-columns-pgr_binaryBreadthFirstSearch
• Post Copyable Unit Tests in Comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.