Pumpup to 3.8.0 #2764

cvvergara · 2025-02-27T15:56:30Z

Changes proposed in this pull request:

@pgRouting/admins

Summary by CodeRabbit

New Features
- Launched pgRouting version 3.8.0 with expanded capabilities for advanced graph analysis and routing.
Documentation
- Updated release notes and standardized naming and formatting for improved clarity.
- Corrected typographical errors and enhanced consistency across user-facing guides and localized strings.
- Added new function signatures and updated existing documentation to reflect changes in functionality.
Chores
- Upgraded build configurations, version tracking, and continuous integration workflows to support the new release.
- Modified workflows for better flexibility in triggering on specific file changes.

coderabbitai · 2025-02-27T15:56:40Z

Walkthrough

This pull request updates the project’s version from 3.7.x to 3.8.0 across the codebase. Version numbers in CI workflows, build scripts, SQL query results, and developer tools are revised. In addition, extensive documentation changes have been made: function signatures, formatting consistency, naming conventions, release notes, and minor text corrections have all been updated. Localization files and SQL signature files have also been updated to reflect the new version.

Changes

File(s)	Change Summary
`.github/workflows/boost_version.yml`, `.github/workflows/update.yml`, `.github/workflows/update-locale.yml`, `tools/testers/pg_prove_tests.sh`	Updated version numbers (e.g., from "3.7.3" to "3.8.0"), adjusted matrix variables, event triggers, and removed owner-based conditions.
`CMakeLists.txt`, `doc/CMakeLists.txt`, `doc/conf.py.in`, `tools/developer/pumpup_version.sh`, `sql/scripts/build-extension-update-files.pl`, `docqueries/version/...`	Updated project and library version metadata to 3.8.0; adjusted build commands and copyright/version strings.
`NEWS.md`, `doc/_static/page_history.js`, various `doc/*/.rst` (e.g., allpairs, astar, bdAstar, bellman_ford, contraction, etc.)	Revised release notes, standardized function signatures and naming (e.g., `pgr_astar` to `pgr_aStar`), corrected formatting and spelling, and restructured documentation sections.
`locale/en/LC_MESSAGES/pgrouting_doc_strings.po`, `locale/pot/pgrouting_doc_strings.pot`	Updated version metadata, POT creation date, and added/modified translation strings.
`sql/sigs/pgrouting--3.8.sig`	Introduced comprehensive new function signatures and internal helper definitions for the updated pgrouting library.

Possibly related PRs

enhancements on dijkstra #2730: The changes in the main PR, which involve updating the version number in a GitHub Actions workflow, are related to the retrieved PR that discusses enhancements to the Dijkstra algorithm, including changes to function signatures and internal implementations, as both PRs reflect updates to versioning and functionality within the pgRouting project.
Pumpup to 3.7.3 #2738: The changes in the main PR, which update the version number in the setup_db.sh script from "3.7.3" to "3.8.0", are related to the changes in the retrieved PR that also modify the version number in the same script from "3.7.2" to "3.7.3". Both PRs involve updates to the versioning in the testing workflow for the database setup process.

Suggested labels

Enhancement

Suggested reviewers

robe2

Poem

I’m a rabbit with hops so bright,
Leaping through code in the moonlight.
Versions updated with care and grace,
Documentation now in its proper place.
Happy to see the new 3.8 shine,
Galloping forward, one commit at a time!

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 159bb05 and 68eb5a4.

📒 Files selected for processing (5)

doc/_static/page_history.js (1 hunks)
doc/circuits/pgr_hawickCircuits.rst (1 hunks)
doc/tsp/pgr_TSP.rst (1 hunks)
doc/tsp/pgr_TSPeuclidean.rst (1 hunks)
locale/pot/pgrouting_doc_strings.pot (103 hunks)

🧰 Additional context used

🪛 Biome (1.9.4)

doc/_static/page_history.js

[error] 7-8: Use let or const instead of var.

A variable declared with var is accessible in the whole module. Thus, the variable can be accessed before its initialization and outside the block where it is declared.
See MDN web docs for more details.
Unsafe fix: Use 'const' instead.

(lint/style/noVar)

🔇 Additional comments (13)

doc/_static/page_history.js (1)

7-7: Good update to include version 3.8 and use modern JS syntax.

The code correctly adds version 3.8 to the array and updates the declaration from var to const, following modern JavaScript best practices.

🧰 Tools

🪛 Biome (1.9.4)

[error] 7-8: Use let or const instead of var.

A variable declared with var is accessible in the whole module. Thus, the variable can be accessed before its initialization and outside the block where it is declared.
See MDN web docs for more details.
Unsafe fix: Use 'const' instead.

(lint/style/noVar)

doc/circuits/pgr_hawickCircuits.rst (1)

16-17: Header Formatting Consistency:
The updated header on line 16 using backticks (pgr_hawickCircuits - Experimental) provides a clearer, code-styled function name. Please verify that this formatting is consistent with similar headers used elsewhere in the documentation.

doc/tsp/pgr_TSP.rst (2)

19-19: Fixed Spelling and Formatting for Function Description
The description now correctly spells “Approximation” and encloses pgr_TSP in double backticks for consistency.

21-23: Verify Version Consistency in Availability Section
The availability section still shows "* Version 3.2.1*" while the PR objective is to update the project’s version to 3.8.0. Please confirm whether this version number reflects the API’s introduction version or if it should be updated to align with the new release.

doc/tsp/pgr_TSPeuclidean.rst (2)

19-19: Corrected Spelling and Improved Function Description
The function description now correctly spells “Approximation” and uses proper double backticks around pgr_TSPeuclidean.

22-23: Verify Version Consistency in Availability Section
The documentation shows "* Version 3.2.1*". Since the release is being pumped up to 3.8.0, please review if this version indicator should also be updated.
locale/pot/pgrouting_doc_strings.pot (7)

3928-3931: Action Required: Update Release Notes for pgRouting 3.8.0

The release notes section for pgRouting 3.8.0 still contains the placeholder text "No Changes Yet". This should be updated with actual release notes describing the changes in this version, such as the standardization of output columns for various functions that are documented in other changes in this file.
#!/bin/bash
# Check if there are any merged PRs labeled for the 3.8.0 release
echo "Looking for merged PRs related to the 3.8.0 release"
gh api graphql -f query='{
  search(query: "repo:pgRouting/pgrouting label:\"3.8.0\" is:pr is:merged", type: ISSUE, first: 10) {
    issueCount
    edges {
      node {
        ... on PullRequest {
          number
          title
        }
      }
    }
  }
}'
9070-9072: Typo in documentation

There's a typo in "e Also" which should be "See Also".

9862-9864: Backtick formatting issue in options documentation

The backtick placement is inconsistent.
-msgid "**options:** [cap, partial, dryrun]``"
+msgid "**options:** [cap, partial, dryrun]"
11089-11093: Inconsistent Boost Graph reference format

The format for the Boost reference is inconsistent with other references in the file.
-msgid "|boost| graph inside."
+msgid "|Boost| Boost Graph Inside"
12628-12632: Fix backtick placement in function signatures

The backticks are placed at the end of the function signatures rather than wrapping the entire signature.
-msgid "pgr_withpointsdd(text,text,bigint,double precision,boolean,character,boolean)``"
+msgid "``pgr_withpointsdd(text,text,bigint,double precision,boolean,character,boolean)``"

-msgid "pgr_withpointsdd(text,text,anyarray,double precision,boolean,character,boolean,boolean)``"
+msgid "``pgr_withpointsdd(text,text,anyarray,double precision,boolean,character,boolean,boolean)``"
1-14: Version and timestamp update look good

The version has been correctly updated to 3.8 and the timestamp has been updated to reflect the current date.

6409-6414: Redundant Boost Graph entries

There appear to be two entries for "Boost Graph Inside" that serve the same purpose and are redundant. Consider keeping only one of them.
-msgid "|Boost| Boost Graph Inside"
-msgstr ""
-
-msgid "Boost Graph inside"
+msgid "|Boost| Boost Graph Inside"

✨ Finishing Touches

📝 Generate Docstrings

🪧 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.
- Generate unit testing code for this file.
- 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 generate unit testing code for this file.
- @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 generate unit testing code.
- @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.

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 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.

coderabbitai

Actionable comments posted: 42

🔭 Outside diff range comments (5)

docqueries/version/full_version.result (2)

1-2: 🧹 Nitpick (assertive)

Transaction Block Consistency

The file begins with two transaction-related lines ("BEGIN;" on line 1 and "BEGIN" on line 2). Please verify that both are expected in this output format. If this is the intended output from the SQL client session, then it is acceptable; otherwise, consider removing any redundancy.

12-15: 🧹 Nitpick (assertive)

Double ROLLBACK Statement Check

The output shows two ROLLBACK statements (lines 13 and 14). Please confirm that this duplication is intentional and aligns with the expected output from the SQL session. If not, consider cleaning up the output to avoid potential confusion.

doc/withPoints/pgr_withPoints.rst (1)

36-40: 🧹 Nitpick (assertive)

Clarify and align signature versioning.
It might be necessary to reconcile whether the new proposal should remain tied to an older version (such as 2.2.0 or 3.2.0) or be updated to reflect the current release (3.8.0). Let us know if you’d like assistance generating a revised versioning scheme for this section.
doc/utilities/pgr_findCloseEdges.rst (1)
65-65: 🧹 Nitpick (assertive)

Inconsistent formatting found in options parameter.

The backtick formatting for the options parameter on this line doesn't match the corrected formatting applied to similar lines elsewhere in the document.
-   | **options:** [cap, partial, dryrun]``
+   | **options:** ``[cap, partial, dryrun]``
tools/developer/pumpup_version.sh (1)
96-97: 🧹 Nitpick (assertive)

⚠️ Potential issue

Correct Git Add Command for Signature File
The cp command correctly copies the old signature file to a new file named using ${NEW_MAYOR}.${NEW_MINOR}, but the subsequent git add mistakenly references ${MAYOR}.${NEW_MINOR} instead of ${NEW_MAYOR}.${NEW_MINOR}. This discrepancy may lead to version control issues.

Apply the following diff to resolve the issue:
-    git add "sql/sigs/pgrouting--${MAYOR}.${NEW_MINOR}.sig"
+    git add "sql/sigs/pgrouting--${NEW_MAYOR}.${NEW_MINOR}.sig"

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 90ddfc7 and 3a16043.

📒 Files selected for processing (58)

.github/workflows/boost_version.yml (1 hunks)
.github/workflows/update.yml (2 hunks)
CMakeLists.txt (2 hunks)
NEWS.md (12 hunks)
doc/CMakeLists.txt (2 hunks)
doc/_static/page_history.js (1 hunks)
doc/allpairs/pgr_floydWarshall.rst (1 hunks)
doc/allpairs/pgr_johnson.rst (1 hunks)
doc/alpha_shape/pgr_alphaShape.rst (2 hunks)
doc/astar/pgr_aStar.rst (2 hunks)
doc/bdAstar/bdAstar-family.rst (2 hunks)
doc/bdAstar/pgr_bdAstar.rst (2 hunks)
doc/bdAstar/pgr_bdAstarCostMatrix.rst (0 hunks)
doc/bdDijkstra/pgr_bdDijkstra.rst (2 hunks)
doc/bellman_ford/pgr_bellmanFord.rst (1 hunks)
doc/circuits/pgr_hawickCircuits.rst (1 hunks)
doc/components/pgr_biconnectedComponents.rst (1 hunks)
doc/components/pgr_bridges.rst (1 hunks)
doc/components/pgr_connectedComponents.rst (1 hunks)
doc/conf.py.in (1 hunks)
doc/dominator/pgr_lengauerTarjanDominatorTree.rst (1 hunks)
doc/driving_distance/pgr_drivingDistance.rst (1 hunks)
doc/lineGraph/pgr_lineGraphFull.rst (1 hunks)
doc/max_flow/pgr_maxCardinalityMatch.rst (1 hunks)
doc/metrics/pgr_betweennessCentrality.rst (2 hunks)
doc/src/index.rst (1 hunks)
doc/src/migration.rst (31 hunks)
doc/src/release_notes.rst (13 hunks)
doc/traversal/pgr_breadthFirstSearch.rst (3 hunks)
doc/trsp/pgr_trsp.rst (2 hunks)
doc/trsp/pgr_trspVia.rst (0 hunks)
doc/tsp/pgr_TSP.rst (1 hunks)
doc/tsp/pgr_TSPeuclidean.rst (1 hunks)
doc/utilities/pgr_findCloseEdges.rst (2 hunks)
doc/withPoints/pgr_withPoints.rst (1 hunks)
doc/withPoints/pgr_withPointsCost.rst (4 hunks)
doc/withPoints/pgr_withPointsCostMatrix.rst (0 hunks)
doc/withPoints/pgr_withPointsKSP.rst (1 hunks)
docqueries/version/full_version.result (1 hunks)
docqueries/version/version.result (1 hunks)
locale/de/LC_MESSAGES/index.po (1 hunks)
locale/de/LC_MESSAGES/pgrouting_doc_strings.po (1 hunks)
locale/en/LC_MESSAGES/index.po (1 hunks)
locale/en/LC_MESSAGES/pgrouting_doc_strings.po (115 hunks)
locale/es/LC_MESSAGES/index.po (1 hunks)
locale/es/LC_MESSAGES/pgrouting_doc_strings.po (2 hunks)
locale/ja/LC_MESSAGES/index.po (1 hunks)
locale/ja/LC_MESSAGES/pgrouting_doc_strings.po (2 hunks)
locale/ko/LC_MESSAGES/index.po (1 hunks)
locale/ko/LC_MESSAGES/pgrouting_doc_strings.po (1 hunks)
locale/pot/index.pot (1 hunks)
locale/pot/pgrouting_doc_strings.pot (113 hunks)
locale/zh_Hans/LC_MESSAGES/index.po (1 hunks)
locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po (2 hunks)
sql/scripts/build-extension-update-files.pl (2 hunks)
sql/sigs/pgrouting--3.8.sig (1 hunks)
tools/developer/pumpup_version.sh (1 hunks)
tools/testers/pg_prove_tests.sh (1 hunks)

💤 Files with no reviewable changes (3)

doc/withPoints/pgr_withPointsCostMatrix.rst
doc/trsp/pgr_trspVia.rst
doc/bdAstar/pgr_bdAstarCostMatrix.rst

🧰 Additional context used

🧠 Learnings (1)

doc/src/release_notes.rst (1)

Learnt from: cvvergara
PR: pgRouting/pgrouting#2744
File: doc/src/release_notes.rst:94-94
Timestamp: 2025-02-06T20:50:07.967Z
Learning: In pgRouting, changes to functions can happen at two levels:
1. SQL level - removal/addition of function signatures
2. C/C++ level - deprecation/changes to the underlying implementation
These are documented separately in the release notes.

🪛 Biome (1.9.4)

doc/_static/page_history.js

[error] 6-7: Use let or const instead of var.

A variable declared with var is accessible in the whole module. Thus, the variable can be accessed before its initialization and outside the block where it is declared.
See MDN web docs for more details.
Unsafe fix: Use 'const' instead.

(lint/style/noVar)

[error] 7-8: Use let or const instead of var.

A variable declared with var is accessible in the whole module. Thus, the variable can be accessed before its initialization and outside the block where it is declared.
See MDN web docs for more details.
Unsafe fix: Use 'const' instead.

(lint/style/noVar)

🪛 LanguageTool

NEWS.md

[typographical] ~6-~6: Two consecutive dots
Context: # pgRouting 3 ## pgRouting 3.8 .. current ### pgRouting 3.8.0 Release No...

(DOUBLE_PUNCTUATION)

[uncategorized] ~1286-~1286: It appears that hyphens are missing.
Context: ...ny version results are the union of the One to One version New Signatures * pgr_bdAs...

(ONE_ON_ONE_HYPHEN)

🪛 markdownlint-cli2 (0.17.2)

NEWS.md

6-6: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

928-928: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

1197-1197: Spaces inside link text
null

(MD039, no-space-in-links)

1288-1288: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

1373-1373: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

1377-1377: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

1477-1477: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

1478-1478: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

1565-1565: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

1566-1566: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

1567-1567: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

1568-1568: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

1570-1570: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

1572-1572: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

1573-1573: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

1574-1574: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

1575-1575: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

1576-1576: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

1577-1577: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

1578-1578: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

1579-1579: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

1608-1608: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

1609-1609: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

1610-1610: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

1611-1611: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

1613-1613: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

1615-1615: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

⏰ Context from checks skipped due to timeout of 90000ms (17)

GitHub Check: Ubuntu Boost (86)
GitHub Check: Ubuntu Boost (84)
GitHub Check: Ubuntu Boost (83)
GitHub Check: Ubuntu Boost (80)
GitHub Check: Ubuntu Boost (79)
GitHub Check: Ubuntu Boost (78)
GitHub Check: Ubuntu Boost (77)
GitHub Check: Ubuntu Boost (76)
GitHub Check: Ubuntu Boost (75)
GitHub Check: Ubuntu Boost (68)
GitHub Check: documentation (zh_Hans)
GitHub Check: macos (macos-14)
GitHub Check: Ubuntu Boost (56)
GitHub Check: documentation (es)
GitHub Check: macos (macos-latest)
GitHub Check: Ubuntu clang
GitHub Check: Codacy Static Code Analysis

🔇 Additional comments (211)

locale/pot/pgrouting_doc_strings.pot (17)

1-14: Version information correctly updated for v3.8

The version has been properly updated in the file header to reflect the new version 3.8.

271-272: Added new message ID for Boost Graph documentation

This new entry will help with localization of Boost Graph references throughout the documentation.

601-602: Added Boost TSP reference link

Good addition of reference link to Boost's metric TSP approximation algorithm documentation.

1492-1493: Added sample data reference

Helpful cross-reference to the sample data documentation.

1642-1643: Added Boost algorithm references

Good additions of links to Boost library documentation for relevant algorithms.

Also applies to: 2422-2423, 2539-2540

3937-3968: Updated release notes with version 3.8.0

Release notes structure has been properly updated with the new version and previous release information.

4066-4067: Updated status of pgr_lineGraph function

Properly documented that the function has been promoted to proposed status.

6253-6254: Database upgrade instructions updated to 3.8.0

The database upgrade instructions have been properly updated to reference version 3.8.0.

6691-6692: Added Boost Graph Inside reference

Added the important reference to Boost Graph library being used internally.

7162-7164: Added Boost references and declarations

Good addition of Boost library references and "Boost Graph Inside" declaration.

Also applies to: 7969-7971, 7975-7977

10819-10820: Added Boost library references

Appropriate references to Boost library documentation have been added throughout.

Also applies to: 11041-11042, 11221-11222, 11278-11279, 11329-11330, 11969-11971, 12103-12105, 12157-12158

12187-12197: Added deprecated function signatures

Properly documented the deprecated function signatures for pgr_trsp.

13558-13560: Documented deprecated function

Properly documented the deprecated function pgr_maxCardinalityMatch(text,boolean).

14131-14133: Updated function documentation

Function documentation has been correctly updated with proper formatting.

Also applies to: 14320-14322, 14797-14799

14575-14576: Updated function status

Function status has been properly updated to "New Function".

14605-14607: Added section for deprecated signatures

Properly added a section for documenting deprecated function signatures.

15490-15491: Updated topology documentation

Topology creation functions documentation has been correctly updated.

locale/ja/LC_MESSAGES/pgrouting_doc_strings.po (2)

2-2: Version updated correctly.

Version has been updated from v3.7.x to v3.8 in the copyright line, which is consistent with the PR objective of bumping to version 3.8.0.

21-21: Project version updated correctly.

The Project-Id-Version has been properly updated to "pgRouting v3.8" which aligns with the PR objective to update version numbers throughout the project.

locale/ko/LC_MESSAGES/pgrouting_doc_strings.po (1)

2-2: Version correctly updated to 3.8.

The version references have been properly updated as part of the pumpup to 3.8.0. Both the copyright statement and Project-Id-Version field now correctly reflect the new version number.

Also applies to: 8-8

docqueries/version/version.result (1)

9-9: Version Number Update Confirmed.
The version string has been correctly updated to "3.8.0" in this query result file, aligning with the PR’s objectives. Please ensure that all related files (e.g., workflow, CMake configuration, release notes) reflect this update consistently.

locale/de/LC_MESSAGES/pgrouting_doc_strings.po (1)

2-2: Version update looks good!

The version has been properly updated to 3.8 in both the copyright statement and the Project-Id-Version field. This change is consistent with the PR objective of updating to version 3.8.0.

Also applies to: 7-7

tools/testers/pg_prove_tests.sh (1)

40-40: Ensure the database setup version is updated to 3.8.0.
The argument change in the call to setup_db.sh now correctly passes "3.8.0", aligning the test setup with the release version update.

doc/withPoints/pgr_withPointsKSP.rst (1)

18-18: Improve title formatting for clarity.
The function title now uses inline code formatting (pgr_withPointsKSP), enhancing readability and consistency with the documentation style.

doc/allpairs/pgr_floydWarshall.rst (1)

31-31: Document the new official status of the function.
Marking pgr_floydWarshall as a "New official function." clarifies its status in this release and aligns with the version bump.

doc/dominator/pgr_lengauerTarjanDominatorTree.rst (1)

16-16: Refine the title presentation.
The updated title now includes a space after the hyphen ("- Experimental"), which improves the readability of the documentation header.

.github/workflows/boost_version.yml (1)

134-134: Update the test workflow to use version 3.8.0.
The version argument passed to the setup_db.sh in the workflow is updated to "3.8.0", ensuring consistency with the overall project version bump.

doc/src/index.rst (1)

92-95: Updated Release Notes Directive: The :end-before: pgRouting 3.7 directive now includes release notes up to version 3.7 rather than the previous version (e.g. 3.6). Given the overall PR aims to pump the software to 3.8.0, please verify that the release notes alignment is intentional and consistent across the documentation.

doc/allpairs/pgr_johnson.rst (1)

29-32: Function Status Update: Marking the pgr_johnson function as a "New official function" clarifies its status transition. This update appears correct and consistent with the version history.

doc/withPoints/pgr_withPointsCost.rst (4)

110-111: Index Entry Update for One to One: The index entry “withPointsCost - Proposed ; One to One - Proposed on v2.2” has been updated to aid in navigation and version clarity. The change looks appropriate.

131-132: Index Entry Update for One to Many: The index entry “withPointsCost - Proposed ; One to Many - Proposed on v2.2” now clearly reflects the intended categorization. Ensure that this style is consistently used throughout the document.

153-154: Index Entry Update for Many to One: The index entry “withPointsCost - Proposed ; Many to One - Proposed on v2.2” has been updated appropriately. This improves the clarity of the various signature variants.

174-175: Index Entry Update for Many to Many: The index entry “withPointsCost - Proposed ; Many to Many - Proposed on v2.2” has been refreshed to match the overall proposed style. This update is clear and consistent with the other categories.

doc/components/pgr_bridges.rst (1)

109-111: Reference Link Formatting Update: The “Boost: Connected components” reference link has been reformatted with capitalized “Connected components” and split over two lines for improved readability. This cosmetic change is appropriate; please ensure that similar references elsewhere follow the same style.

doc/circuits/pgr_hawickCircuits.rst (2)

16-17: Title Formatting Update
The title has been updated to use inline code (pgr_hawickCircuits) while still indicating it is experimental. This improves visual clarity in the documentation.

25-27: Version Information Clarification
The “Availability” section lists Version 3.4.0. Please verify that this version is correct for the experimental function—even though the overall project version bumps to 3.8.0—so that the historical and current versioning are aligned as intended.

doc/bellman_ford/pgr_bellmanFord.rst (3)

11-13: Index and Title Consistency
The index entries and title now correctly reference pgr_bellmanFord as “- Experimental”. This provides the expected clarity for an experimental function.

267-267: Hyperlink Text Correction
The updated hyperlink (line 267) now correctly shows “Boost: Bellman Ford” instead of a misspelling. This enhances clarity and proper attribution.

27-28: Version History Verification
The “Availability” section shows multiple version entries (e.g. Version 3.2.0 and Version 3.0.0). Please double-check that these historical entries remain correct in light of the overall project update to 3.8.0.

doc/bdAstar/bdAstar-family.rst (2)

56-57: Consistent Function Naming
Changing the function name reference to pgr_aStar (instead of the previous pgr_astar) helps enforce a consistent naming convention across the documentation.

64-66: Enhanced Link Description
The revision from a generic “Boost” link to “Boost: A* search” clearly explains the context of the linked reference. This minor detail improves reader clarity.

doc/lineGraph/pgr_lineGraphFull.rst (2)

146-148: Clarification in Examples Section
The examples description has been updated to explicitly state “:doc:sampledata network” and further clarify the subgraph details (edges 4, 7, 8, and 10 with reverse_cost). This extra detail improves context for users reviewing the example queries.

26-29: Version Information Consistency Check
The “Availability” section still mentions Version 2.6.0. Please verify that this version is intended for this experimental function as the overall release is bumped to 3.8.0.

doc/bdDijkstra/pgr_bdDijkstra.rst (3)

36-36: Minor Text Adjustment in Version History
The change to “New proposed signatures:” (with “proposed” in lowercase) improves consistency with the style guidelines.

50-50: Status Update Clarity
The entry “New official function.” now clearly signals the promotion of the function. This status information is now more consistent throughout the document.

22-25: Versioning Consistency Inquiry
The header and version history (e.g. Version 3.2.0, Version 3.0.0, etc.) use older version numbers. Please confirm that these historical notes should remain unchanged despite the overall project update to 3.8.0—or if additional adjustments are needed.

docqueries/version/full_version.result (1)

9-9: Version Update Confirmation

The version and library values have been correctly updated to "3.8.0" and "pgrouting-3.8.0" respectively, in line with the PR objectives. This change appears correct and consistent with other parts of the update.

locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po (2)

1-5: Version Header Update Verification

The file header now correctly reflects the update with "pgRouting v3.8" (line 2) and updates the copyright notice accordingly. Ensure that this version update is consistent across all locale files.

9-15: Project-Id-Version Field Update

The "Project-Id-Version" field has been updated to "pgRouting v3.8" (line 12), which aligns with the new release. Please verify that this change is consistent with similar updates in other localization files.

locale/es/LC_MESSAGES/pgrouting_doc_strings.po (2)

1-5: Update Localization File Header Version
The header now reflects the updated version "v3.8" as required by the version bump. This change clearly aligns the localization metadata with the new release and appears consistent with the overall PR objectives.

8-14: Update of Project-Id-Version Metadata
The "Project-Id-Version" field has been updated to "pgRouting v3.8", which correctly reflects the new version across localization files. Ensure this change is consistent in any other locale files if applicable.

doc/components/pgr_connectedComponents.rst (1)

28-29: Consistent documentation formatting applied.
The modifications to enclose “n_seq” and “seq” in backticks make the instructions clearer. The changes mirror those in the biconnected components document and adhere to the style guidelines.

.github/workflows/update.yml (2)

32-32: Verify the update of the old_pgr matrix versions.
The “old_pgr” matrix now includes an extensive list of previous versions (e.g., 3.7.3, 3.7.2, etc.). Confirm that this comprehensive list is intentional and that these versions are required for testing the upgrade path to 3.8.0.

129-129: Update the extension version correctly.
The ALTER EXTENSION command updating pgrouting to “3.8.0” aligns with the overall version bump. It is important to ensure that the test job validates this upgrade without issues in the CI pipeline.

locale/pot/index.pot (2)

2-2: Updated version metadata in copyright.
Changing the header from “Version v3.7.2” to “Version v3.8” is correct. Please ensure that this update is consistently applied in all localization files.

9-9: Corrected Project-Id-Version metadata.
The “Project-Id-Version: pgRouting v3.8” string correctly reflects the new version.

doc/withPoints/pgr_withPoints.rst (1)

81-90: Ensure signature examples remain valid.
The multiple signature examples are comprehensive and clear. Please double-check that they align with the new proposed signature and that any updates to the parameters or ordering are uniformly reflected in both textual descriptions and example queries.

doc/metrics/pgr_betweennessCentrality.rst (2)

141-141: URL updated to use a more maintainable pattern.

The URL to the Boost documentation has been updated to remove the specific version number (1_84_0), which makes the link more maintainable as it will point to the latest documentation rather than a specific version.

19-19: Corrected terminology in documentation.

The term "betweenness centrality" is now correctly spelled in the function description.

sql/scripts/build-extension-update-files.pl (2)

67-67: Added version regex pattern for 3.8.

Added new version regex pattern to support the 3.8.x series.

77-77: Updated current version to 3.8.

Updated the $current variable to use the new 3.8 regex pattern, which is essential for proper version management during the bump from 3.7.x to 3.8.0.

doc/traversal/pgr_breadthFirstSearch.rst (1)

58-58: Fixed documentation formatting for options parameter.

Corrected the backtick formatting for the options parameter in all function signatures, ensuring consistent presentation of code elements in the documentation.

Also applies to: 72-72, 93-93

doc/utilities/pgr_findCloseEdges.rst (2)

36-36: Fixed documentation formatting for EMPTY SET message.

Corrected the backtick formatting for the "EMPTY SET" message.

50-50: Fixed documentation formatting for options parameter.

Corrected the backtick formatting for the options parameter.

doc/alpha_shape/pgr_alphaShape.rst (1)

39-41: Update Function Status for pgr_alphaShape

The status bullet has been updated to “* New official function.” in this version. This clearly indicates the function's promotion and aligns with the new documentation standards. Please ensure that other related documentation files use a consistent status format.

locale/en/LC_MESSAGES/index.po (2)

2-2: Version Update in Copyright Header

The version in the copyright header has been updated to "v3.8". This aligns with the overall project version bump.

9-9: Project Identifier Version Update

The "Project-Id-Version" entry is now updated to "pgRouting v3.8". Ensure that this change is reflected throughout all version-related documents in the project.

doc/tsp/pgr_TSPeuclidean.rst (1)

19-20: Consistent Function Name Formatting

The function name pgr_TSPeuclidean is now properly wrapped in double backticks, and the updated description (“Aproximation using metric algorithm”) is clear.

doc/bdAstar/pgr_bdAstar.rst (2)

55-57: Updated Function Status for pgr_bdAstar

The version 2.0.0 entry now reads “* New official function.” This update aligns with the new categorization and clearly communicates the function’s official status.

105-107: Signature Options Formatting

The separate line showing the available options ([directed, heuristic, factor, epsilon]) is clear and consistent with similar sections in the documentation. Please verify that this formatting is uniform across all similar function signatures.

doc/astar/pgr_aStar.rst (2)

51-53: Updated Signature Information

The documentation now reflects the signature change for pgr_aStar(One to One). Please verify that all examples and references now consistently use the new signature.

57-59: Function Status Promotion

The updated status “New official function.” clearly conveys the intended change. This update is consistent with changes in related documentation.

doc/_static/page_history.js (1)

7-7: Version added to the supported versions array.

The array of supported versions has been updated to include '3.8' as the newest version. This change is consistent with the PR objective of pumping up to version 3.8.0.

🧰 Tools

🪛 Biome (1.9.4)

[error] 6-7: Use let or const instead of var.

A variable declared with var is accessible in the whole module. Thus, the variable can be accessed before its initialization and outside the block where it is declared.
See MDN web docs for more details.
Unsafe fix: Use 'const' instead.

(lint/style/noVar)

[error] 7-8: Use let or const instead of var.

A variable declared with var is accessible in the whole module. Thus, the variable can be accessed before its initialization and outside the block where it is declared.
See MDN web docs for more details.
Unsafe fix: Use 'const' instead.

(lint/style/noVar)

CMakeLists.txt (3)

33-34: Project version updated to 3.8.0.

The project version has been updated from 3.7.3 to 3.8.0, which aligns with the PR objective of pumping up the version number.

46-46: Updated list of minor versions.

The MINORS list has been updated to include 3.8 at the beginning, keeping the correct ordering of versions.

47-48: Added 3.7.3 to OLD_SIGNATURES list.

Version 3.7.3 has been added to the OLD_SIGNATURES list to ensure backward compatibility with previous versions.

locale/es/LC_MESSAGES/index.po (2)

2-2: Updated copyright version to 3.8.

The copyright notice has been updated to reference version 3.8, maintaining consistency with the version update across the project.

8-8: Updated Project-Id-Version to v3.8.

The Project-Id-Version field has been updated to pgRouting v3.8, ensuring translation metadata correctly reflects the current version.

locale/zh_Hans/LC_MESSAGES/index.po (2)

2-2: Updated copyright version to 3.8.

The copyright notice has been updated to reference version 3.8, maintaining consistency with the version update across the project.

8-8: Updated Project-Id-Version to v3.8.

The Project-Id-Version field has been updated to pgRouting v3.8, ensuring translation metadata correctly reflects the current version.

doc/conf.py.in (2)

76-76: Version number format updated in copyright string

The update changes the version format from @PROJECT_FULL_VERSION@ to v@PROJECT_LIB_VERSION@, aligning with the version bump to 3.8.0.

83-83: Version variable format updated

The version variable now uses v@PROJECT_LIB_VERSION@ instead of @PROJECT_FULL_VERSION@, providing a consistent format with a "v" prefix.

locale/de/LC_MESSAGES/index.po (2)

2-2: Updated copyright version to v3.8

The copyright version has been correctly updated as part of the version bump to 3.8.0.

8-8: Updated Project-Id-Version to v3.8

The Project-Id-Version has been correctly updated from v3.7.2 to v3.8 for the German locale.

locale/ja/LC_MESSAGES/index.po (2)

2-2: Updated copyright version to v3.8

The copyright version has been correctly updated as part of the version bump to 3.8.0.

8-8: Updated Project-Id-Version to v3.8

The Project-Id-Version has been correctly updated from v3.7.2 to v3.8 for the Japanese locale.

locale/ko/LC_MESSAGES/index.po (2)

2-2: Updated copyright version to v3.8

The copyright version has been correctly updated as part of the version bump to 3.8.0.

8-8: Updated Project-Id-Version to v3.8

The Project-Id-Version has been correctly updated from v3.7.2 to v3.8 for the Korean locale.

doc/trsp/pgr_trsp.rst (2)

41-44: Enhanced Deprecated Signatures Formatting
The deprecated signatures are now listed without extra backticks, which improves readability and aligns with the updated documentation style.

50-51: Clear Presentation of New Prototypes
The new prototypes (pgr_trspViaVertices and pgr_trspViaEdges) are clearly listed, making it easier for users to identify the current APIs.

doc/driving_distance/pgr_drivingDistance.rst (2)

27-28: Enhanced Single Vertex Signature Documentation
The single vertex signature now notes the addition of the depth and start_vid result columns; this update improves clarity on the expected output.

31-34: Enhanced Multiple Vertices Signature Documentation
The changes explicitly document the renaming of the result column from from_v to start_vid and the inclusion of a new column pred. Please verify that these documentation changes are consistent with the actual function’s output.

doc/max_flow/pgr_maxCardinalityMatch.rst (2)

31-31: Clarified New Signature Documentation
The new signature now clearly states that pgr_maxCardinalityMatch(text) returns only the edge column, which improves the clarity of expected results.

35-37: Updated Deprecated Signature and Parameter Formatting
The deprecated signature and associated parameter description (with directed correctly shown as false) now follow a cleaner, more consistent style.

tools/developer/pumpup_version.sh (1)

155-157: Localization and Documentation Version Update
The Perl commands updating the copyright notices in the locale files and the version array in page_history.js now correctly use the new major and minor version numbers. The regex patterns appear well crafted—please ensure they work as expected across all target files.

locale/en/LC_MESSAGES/pgrouting_doc_strings.po (95)

2-11: No issues found with these version metadata changes.

285-286: No issues found in these added doc strings.

661-661: No issues found with the TSP link reference.

1621-1621: No issues found in this reference to sample data.

1783-1785: No issues found with the A search doc reference.*

2595-2597: No issues found with the Boost link text.

4380-4437: No issues found in these release notes references.

4544-4544: No issues found with the note on function promotion.

4643-4649: No issues found with these migration notes.

4790-4794: No issues found with these drivingDistance doc lines.

4811-4813: No issues found in these references to single-vertex usage.

4830-4831: No issues found in these multiple-vertices references.

4926-4926: No issues found with the new pgr_KSP reference.

4935-4939: No issues found with the pgr_KSP mention.

4982-4982: No issues found regarding pgr_maxCardinalityMatch doc line.

5020-5020: No issues found in the prim/kruskal migration note.

5208-5208: No issues found in the withPointsKSP reference.

5217-5219: No issues found in the new output columns reference.

5497-5497: No issues found—just a heading for pgr_trsp doc.

7133-7133: No issues found with upgrade command line doc.

7586-7586: No issues found with the pgr_KSP doc heading.

7634-7643: No issues found in the TSP doc references.

7998-7998: No issues found regarding new official function reference.

8192-8195: No issues found in the aStarCost doc references.

8395-8395: No issues found relating to pgr_analyzeGraph reference.

8668-8668: No issues with pgr_analyzeOneWay mention.

8819-8819: No issues found with new experimental function note.

8852-8852: No issues found with the biconnected components reference.

8905-8907: No issues found with pgr_bdAstarCost references.

9038-9038: No issues found with bdDijkstraCost references.

9102-9106: No issues found with new bellmanFord signature references.

9200-9200: No issues found with the betweennessCentrality doc line.

9274-9274: No issues found referencing betweenness centrality doc.

9289-9293: No issues found; references to changes in result columns are clear.

9347-9347: No issues found with binaryBreadthFirstSearch doc.

9409-9412: No issues found with BFS link references.

9475-9484: No issues found with bipartite references.

9494-9494: No issues found referencing boykovKolmogorov doc.

9538-9540: No issues found referencing boykovKolmogorov max flow example.

9573-9573: No issues found with BFS coverage note.

9654-9657: No issues found with connected components references.

9715-9715: No issues found with pgr_chinesePostman mention.

9753-9754: No issues found referencing connected components doc.

9930-9930: No issues found referencing createTopology doc.

10134-10134: No issues found referencing createVerticesTable doc.

10352-10352: No issues found referencing dagShortestPath doc.

10431-10435: No issues found with explanation of DAG usage.

10608-10608: No issues found referencing DFS doc.

10838-10845: No issues found with Dijkstra doc references.

10858-10858: No issues found referencing dijkstraCost(Combinations) doc.

11323-11333: No issues found in these drivingDistance signature notes.

11389-11389: No issues found with edgeColoring reference.

11461-11470: No issues found; references to edge coloring look consistent.

11560-11560: No issues found regarding edmondsKarp mention.

11584-11587: No issues found referencing edmonds_karp_max_flow.

11662-11662: No issues found with pgr_extractVertices mention.

11764-11764: No issues found referencing pgr_findCloseEdges.

11792-11792: No issues found referencing function options.

11831-11833: No issues found referencing the multi-points example.

12448-12450: No issues found referencing Boyer Myrvold doc link.

12581-12581: No issues found referencing KruskalDFS doc.

12638-12640: No issues found referencing Lengauer-Tarjan dominator doc.

12647-12647: No issues found referencing lineGraph mention.

12918-12918: No issues found referencing sample data usage.

13137-13140: No issues found regarding make connected references.

13156-13159: No issues found in the “Deprecated signature” lines.

13210-13212: No issues found with maximum matching doc reference.

13229-13229: No issues found referencing pgr_maxFlow(Combinations).

13268-13270: No issues found referencing push relabel max flow doc.

13339-13339: No issues found with maxFlowMinCost_Cost doc reference.

13372-13372: No issues found referencing pgr_nodeNetwork doc.

13910-13910: No issues found with pushRelabel doc mention.

13931-13940: No issues found regarding sequentialVertexColoring doc.

13983-13987: No issues found with pgr_sequentialVertexColoring references.

14076-14078: No issues found with Stoer Wagner min cut references.

14092-14097: No issues found; clarifies changes to n_seq and seq columns.

14116-14116: No issues found referencing strong_components doc.

14180-14184: No issues found referencing topological sort doc.

14374-14374: No issues found referencing pgr_trspVia.

14626-14626: No issues found referencing pgr_trsp_withPoints.

14739-14739: No issues found for turnRestrictedPath mention.

14817-14817: No issues found referencing pgr_vrpOneDepot doc.

15159-15162: No issues found referencing withPointsDD doc changes.

15180-15187: No issues found referencing signature definitions.

15304-15315: No issues found referencing withPointsKSP expansions.

15928-15928: No issues found referencing newly proposed functions note.

15943-15999: No issues found referencing TRSP extended docs.

16003-16013: No issues found referencing trsp-related deprecated functions.

16046-16048: No issues found referencing optional parameters note.

16778-16780: No issues found with the Components family references.

16994-16996: No issues found referencing KSP doc overview.

17303-17308: No issues found referencing new function references.

17333-17333: No issues found referencing pgr_bddijkstra deprecation.

17557-17559: No issues found with pgr_nodeNetwork improvements note.

18383-18385: No issues found referencing the general topology and analysis info.
doc/CMakeLists.txt (2)

265-268: Updated sphinx‐intl command with POT path.
The new command
COMMAND sphinx-intl update -p ${CMAKE_SOURCE_DIR}/locale/pot -d ${CMAKE_SOURCE_DIR}/locale -l en > locale_changes.txt
ensures the correct .pot file path is used for generating locale files. Please verify that this change fully supports your locale update workflow.

295-300: Enhanced documentation build flags.
The addition of the flags
-n   # warn about all missing references
--color
improves output readability and helps catch missing references during the build. Please confirm that your Sphinx version supports these flags and that they work as expected in your environment.
NEWS.md (1)

4-12: New release notes section for pgRouting 3.8.0.
The updated NEWS file now includes a new section titled “## pgRouting 3.8” and “### pgRouting 3.8.0 Release Notes” with a placeholder “No Changes Yet.” This is clear and consistent with earlier release note formats. Make sure to update this section with actual changes when they become available.

🧰 Tools

🪛 LanguageTool

[typographical] ~6-~6: Two consecutive dots
Context: # pgRouting 3 ## pgRouting 3.8 .. current ### pgRouting 3.8.0 Release No...

(DOUBLE_PUNCTUATION)

🪛 markdownlint-cli2 (0.17.2)

6-6: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

doc/src/migration.rst (16)

12-37: Migration guide: Formatting and clarity for pgr_aStar.
The migration instructions for pgr_aStar now consistently use backticks for function names and clearly list the overloads (i.e. One to One, One to Many, and Many to One). The before/after examples provided via literalinclude directives enhance readability.

96-117: Migration instructions for pgr_bdAstar.
This section clearly details the output differences across the overloads of pgr_bdAstar, indicating which columns (start_vid and end_vid) are missing in each case. The inclusion of literalinclude examples is very helpful to verify migration steps.

164-186: Detailed migration steps for pgr_dijkstra.
The changes explain the addition of start_vid and end_vid columns for the different overloads of pgr_dijkstra. The instructions and provided literalinclude examples (showing the before/after cases) are clear and consistent with the overall migration documentation.

230-256: Comprehensive migration for pgr_drivingDistance.
This section documents the renaming of the from_v column to start_vid and the addition of new output columns such as depth and pred. The before/after migration examples via literalinclude help confirm the changes.

304-313: Migration for the Kruskal functions group.
The migration instructions for pgr_kruskalDD, pgr_kruskalBFS, and pgr_kruskalDFS are concise. Notably, the addition of the pred column is explained clearly, and the sample queries provided serve as good verification examples.

388-414: Migration instructions for pgr_KSP.
The documentation now details the updated output—specifically, that pgr_KSP (One to One) now returns start_vid and end_vid. The example provided (via literalinclude) makes it easy to follow. All changes are consistent with the other migration sections.

434-458: Updated migration for pgr_maxCardinalityMatch.
The new instructions explain the removal of the optional directed flag and the focus on returning only the edge column. The before/after examples clarify this change effectively.

486-510: Migration details for the prim family.
The migration steps for pgr_primDD, pgr_primBFS, and pgr_primDFS are well documented. The addition of the pred column and the explanation using literalinclude blocks provides clear guidance for users migrating their queries.

570-600: Extensive migration instructions for pgr_withPointsDD.
This section carefully explains the changes in the function signature—most notably, the transition of the driving_side parameter from an optional named parameter to an unnamed compulsory parameter. The detailed explanation of the new output columns (start_vid, depth, pred) along with the literalinclude examples is very useful.

712-767: Clear migration steps for pgr_withPointsKSP.
The guide explains how the output columns and the driving_side parameter have been updated in pgr_withPointsKSP. The provided examples are consistent with other migration sections and aid in understanding the changes.

768-808: Migration instructions for pgr_trsp (Vertices).
The migration guide for the vertex version of pgr_trsp is clearly structured, with literalinclude examples that illustrate the transformation. The recommendation to switch to pgr_dijkstra in the absence of restrictions is well noted.

826-870: Migration instructions for pgr_trsp (Edges).
This section documents the signature updates for the edge version of pgr_trsp and explains the necessary column renaming. It might be useful to include a brief summary differentiating edge-based from vertex-based migrations; otherwise, the documentation is clear and helpful.

886-914: Migration for pgr_trspViaVertices.
The updated instructions for migrating pgr_trspViaVertices effectively detail the function signature changes and new output columns. The literalinclude examples further help users verify that their migration is correct.

949-959: Migration instructions for pgr_trspViaEdges.
The section clearly defines the changes in the signature and the output for pgr_trspViaEdges, including a deprecation note. The provided examples help illustrate how to adapt existing queries to the new format.

1011-1070: Comprehensive migration guide for restrictions.
This part of the document explains in depth the transformation from the old restrictions structure to the new one. It covers column renaming, data type changes, and even includes an example of using the auxiliary function _pgr_array_reverse. The step-by-step literalinclude examples make a complex subject much more approachable. Consider adding a short summary or checklist for users unfamiliar with array reversals.

1125-1134: Documentation on indices and tables.
The final section listing indices and table references provides a useful quick reference. It is clear and consistent with the rest of the documentation.

sql/sigs/pgrouting--3.8.sig (2)

14-20: Ensure consistency and clarity between _pgr_astar / pgr_astar and _pgr_bdastar / pgr_bdastar.

You are introducing both “public” (pgr_) and “internal” (_pgr_) variations of these methods. Double-check that:

Input parameters are consistently ordered and typed across both variations.

Any internal or private methods (_pgr_) are hidden from end users if not intended for direct public consumption.

Also applies to: 27-33

301-305: Confirm TSP function parameter alignment.

New TSP signatures (pgr_tsp and _pgr_tsp) include multiple parameters for bigints, integer sizes, and double precision thresholds. Carefully verify that calling code matches these parameter types, and that you handle boundary conditions (e.g., negative or zero distances).

locale/pot/pgrouting_doc_strings.pot

locale/en/LC_MESSAGES/pgrouting_doc_strings.po

doc/src/release_notes.rst

sql/sigs/pgrouting--3.8.sig

coderabbitai

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3a16043 and e9da1ab.

📒 Files selected for processing (8)

.github/workflows/update-locale.yml (1 hunks)
doc/contraction/contraction-family.rst (4 hunks)
locale/de/LC_MESSAGES/pgrouting_doc_strings.po (2 hunks)
locale/es/LC_MESSAGES/pgrouting_doc_strings.po (3 hunks)
locale/ja/LC_MESSAGES/pgrouting_doc_strings.po (3 hunks)
locale/ko/LC_MESSAGES/pgrouting_doc_strings.po (2 hunks)
locale/pot/pgrouting_doc_strings.pot (102 hunks)
locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po (3 hunks)

🔇 Additional comments (25)

.github/workflows/update-locale.yml (2)

11-14: Enhanced Trigger Conditions by Specifying File Paths

The workflow is now explicitly triggered when changes occur in the locale workflow file or anywhere within the doc/ directory. This ensures that the job only runs for relevant modifications, reducing unnecessary runs and aligning with the goal of proper localization version management.

15-16: Exclusion of the gh-pages Branch

The addition of branches-ignore for the gh-pages branch prevents the workflow from running on static site updates, which is beneficial since such changes don’t require localization updates. This adheres to best practices by reducing redundant CI runs.
locale/pot/pgrouting_doc_strings.pot (8)

1-14: Version information correctly updated

The version has been updated from 3.7 to 3.8 in both the copyright line and the Project-Id-Version field, consistent with the PR objective to "Pump up to 3.8.0".

9070-9072: Typo in documentation

There's a typo in "e Also" which appears to be a fragment.
-msgid "e Also"
+msgid "See Also"
9862-9864: Backtick formatting issue in options documentation

The backtick placement is inconsistent.
-msgid "**options:** [cap, partial, dryrun]``"
+msgid "**options:** [cap, partial, dryrun]"
4102-4105: Good standardization documentation

The migration documentation for pgr_drivingDistance is well structured and will help users understand the changes in the function's result columns.

5971-5972: Documentation updated for version 3.8.0

The upgrade instructions have been correctly updated to reference version 3.8.0.

10573-10575: Clear documentation for pgr_lineGraph promotion

The documentation clearly indicates that pgr_lineGraph now works for both directed and undirected graphs and has been promoted to a proposed signature.

9463-9465: Good standardization documentation

The documentation for standardizing output columns in pgr_drivingDistance with the new result-spantree format is clear and helpful.

12925-12927: Version section added for 3.8

A new section has been added for pgRouting 3.8 release notes, which is consistent with the version bump in this PR.
locale/ja/LC_MESSAGES/pgrouting_doc_strings.po (3)

2-2: Confirmed version update in copyright notice.

The copyright notice correctly reflects the version update to v3.8.

21-21: Confirmed version update in Project-Id-Version field.

The Project-Id-Version field has been properly updated to "pgRouting v3.8", aligning with the primary goal of this PR.

2895-2895: New message string added for localization.

A new message string "Adjacent nodes" has been added, which needs Japanese translation. This appears to be new content related to the 3.8.0 release.

Is there a corresponding translation task for ensuring all new strings get translated? The string currently has an empty translation.

locale/ko/LC_MESSAGES/pgrouting_doc_strings.po (2)

2-2: Version update looks good.

The version has been correctly updated from v3.7.2 to v3.8 in both the copyright notice and Project-Id-Version fields, which aligns with the PR objective of bumping the version to 3.8.0.

Also applies to: 8-8

2872-2872: New documentation string needs translation.

The message string "Adjacent nodes" has been added or modified, but its translation is currently empty. Consider having this string translated into Korean to maintain complete localization.

locale/de/LC_MESSAGES/pgrouting_doc_strings.po (2)

1-10: Version number updated correctly for the 3.8.0 release.

The version information has been properly updated from v3.7.2 to v3.8 in both the copyright notice and Project-Id-Version field. This aligns with the PR objective to pump up the version to 3.8.0.

2859-2859: New localization string added.

The addition of the "Adjacent nodes" string will ensure proper localization of this term in the German translation. This string appears to be part of the broader consistency improvements mentioned in the summary.

locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po (3)

2-2: Version update looks good.

The copyright notice has been correctly updated to reflect the new version 3.8.

12-12: Project-Id-Version update looks good.

The Project-Id-Version field has been correctly updated to reflect the new version 3.8, which is consistent with the PR objective to pump up to version 3.8.0.

2954-2954: Spelling correction looks good.

Fixed the spelling error by changing "Adjecent nodes" to "Adjacent nodes". This correction improves the documentation quality.

locale/es/LC_MESSAGES/pgrouting_doc_strings.po (3)

1-5: Version Bump Update Validated.
The header now correctly reflects the update with "Version v3.8". Please confirm that this version format aligns with the rest of the project (e.g., using "v3.8" vs. "v3.8.0") for consistency.

8-14: Project-Id-Version Field Updated.
The "Project-Id-Version" metadata is now updated to "pgRouting v3.8", which is correct. Verify this change against other localization files to ensure consistency across the project.

3142-3148: Typographical Correction Confirmed.
The typo in the message identifier has been fixed from "Adjecent nodes" to "Adjacent nodes", which improves clarity in the translation strings.

doc/contraction/contraction-family.rst (2)

102-102: Spelling Correction in Dead End Table Header
The header now correctly reads "Adjacent nodes" instead of the misspelled "Adjecent nodes". This improves clarity and accuracy in the documentation.

143-143: Spelling Correction in Linear Table Header
The header in the list table for the linear contraction section is corrected from "Adjecent nodes" to "Adjacent nodes", ensuring consistency in terminology across the document.

locale/pot/pgrouting_doc_strings.pot

coderabbitai

Actionable comments posted: 1

♻️ Duplicate comments (5)

locale/pot/pgrouting_doc_strings.pot (5)
3928-3931: ⚠️ Potential issue

Release notes still contain placeholder text

The pgRouting 3.8.0 release notes section still contains the placeholder text "No Changes Yet" which should be replaced with actual release notes describing the changes in this version.

6409-6414: 🧹 Nitpick (assertive)

Redundant Boost Graph entries

There appear to be two entries for "Boost Graph Inside" that serve the same purpose and are redundant.
-msgid "|Boost| Boost Graph Inside"
-msgstr ""
-
-msgid "Boost Graph inside"
+msgid "|Boost| Boost Graph Inside"
9070-9072: ⚠️ Potential issue

Typo in documentation

There's a typo in "e Also" which should be "See Also".
-msgid "e Also"
+msgid "See Also"
9862-9864: ⚠️ Potential issue

Backtick formatting issue in options documentation

The backtick placement is inconsistent.
-msgid "**options:** [cap, partial, dryrun]``"
+msgid "**options:** [cap, partial, dryrun]"
12628-12632: ⚠️ Potential issue

Fix backtick placement in function signatures

The backticks are placed at the end of the function signatures rather than wrapping the entire signature.
-msgid "pgr_withpointsdd(text,text,bigint,double precision,boolean,character,boolean)``"
+msgid "``pgr_withpointsdd(text,text,bigint,double precision,boolean,character,boolean)``"

-msgid "pgr_withpointsdd(text,text,anyarray,double precision,boolean,character,boolean,boolean)``"
+msgid "``pgr_withpointsdd(text,text,anyarray,double precision,boolean,character,boolean,boolean)``"

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1b77c6f and 159bb05.

📒 Files selected for processing (2)

doc/contraction/contraction-family.rst (4 hunks)
locale/pot/pgrouting_doc_strings.pot (102 hunks)

🔇 Additional comments (11)

doc/contraction/contraction-family.rst (4)

102-103: Spelling Correction: 'Adjacent nodes' header in the undirected dead end vertex table.
The column header has been updated to correctly spell "Adjacent nodes", which enhances clarity and consistency in the documentation.

143-146: Spelling Correction: 'Adjacent nodes' header in the directed dead end vertex table.
This update fixes the typo in the header, ensuring consistent terminology in the table that lists vertex information.

285-286: Spelling Correction: 'Adjacent nodes' header in the undirected linear vertex table.
The correction aligns the terminology with other tables in the document, thereby improving uniformity.

323-325: Spelling Correction: 'Adjacent nodes' header in the directed linear vertex table.
Updating the header to "Adjacent nodes" removes the previous typo and contributes to the overall consistency of the document.

locale/pot/pgrouting_doc_strings.pot (7)

1-14: Update to pgRouting version 3.8 completed correctly in the header

The version information in the header has been properly updated to reflect the new pgRouting version 3.8.

5971-5974: Version update in upgrade instruction completed correctly

The upgrade instruction has been correctly updated to reference version 3.8.0.

12925-12928: New version entry added correctly

A new entry for pgRouting 3.8 has been correctly added to the documentation.

9463-9466: Output column standardization documented correctly

Documentation for standardizing output columns to result-spantree format for pgr_drivingDistance has been correctly added.

8863-8872: Output column standardization documented correctly for pgr_dijkstra

Documentation about standardizing output columns for the pgr_dijkstra family of functions has been correctly added, including the addition of start_vid and end_vid columns.

7447-7457: Output column standardization documented correctly for pgr_bdAstar

Documentation about standardizing output columns for the pgr_bdAstar family of functions has been correctly added, including the addition of start_vid and end_vid columns.

6796-6805: Output column standardization documented correctly for pgr_aStar

Documentation about standardizing output columns for the pgr_aStar family of functions has been correctly added, including the addition of start_vid and end_vid columns.

locale/pot/pgrouting_doc_strings.pot

cvvergara added 3 commits February 27, 2025 09:32

Adjusting pumpup to set minor version in locale files

2fb54e4

Pump up to 3.8.0

acb9bd1

(doc) Simplifying migration, backport doc fixes from develop

3a16043

cvvergara added the Administrative label Feb 27, 2025

cvvergara added this to the Release 3.8.0 milestone Feb 27, 2025

cvvergara requested a review from robe2 February 27, 2025 15:56

cvvergara self-assigned this Feb 27, 2025

(CI) adjusting update-locale to work on push

0d22716

cvvergara force-pushed the pumpup-to-3.8.0 branch from fa8e7c4 to bc6728a Compare February 27, 2025 16:08

coderabbitai bot reviewed Feb 27, 2025

View reviewed changes

locale/pot/pgrouting_doc_strings.pot Show resolved Hide resolved

locale/pot/pgrouting_doc_strings.pot Show resolved Hide resolved

locale/pot/pgrouting_doc_strings.pot Show resolved Hide resolved

cvvergara force-pushed the pumpup-to-3.8.0 branch from e9da1ab to 09c72a6 Compare February 27, 2025 16:22

Fix spelling: Adjecent -> Adjacent

26d7d9f

cvvergara force-pushed the pumpup-to-3.8.0 branch from 1b77c6f to 26d7d9f Compare February 27, 2025 16:28

coderabbitai bot reviewed Feb 27, 2025

View reviewed changes

locale/pot/pgrouting_doc_strings.pot Show resolved Hide resolved

Fixing code rabit issues

6095aa3

cvvergara force-pushed the pumpup-to-3.8.0 branch from 159bb05 to 6095aa3 Compare February 27, 2025 16:45

Update locale: commit 6095aa3

68eb5a4

robe2 approved these changes Feb 27, 2025

View reviewed changes

cvvergara merged commit cf9c792 into pgRouting:main Feb 27, 2025
1 check passed

cvvergara deleted the pumpup-to-3.8.0 branch February 27, 2025 17:03

This was referenced Feb 27, 2025

Issue 2770 improve internal functions #2771

Merged

pgr_extractVertices promoted to official #2773

Merged

Remove partial option on pgr find close edges #2776

Merged

(pgr_degree) Adding new overload with only edges SQL #2782

Merged

coderabbitai bot mentioned this pull request Mar 8, 2025

Ci update test fix #2784

Merged

This was referenced Mar 21, 2025

New signature pgr contraction #2789

Merged

Pump up to 3.7.1 #2685

Merged

coderabbitai bot mentioned this pull request Apr 5, 2025

Removing use of pgr_analyzeGraph on the documentation #2822

Merged

coderabbitai bot mentioned this pull request Apr 8, 2025

Deprecate pgr create topology #2830

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Pumpup to 3.8.0 #2764

Pumpup to 3.8.0 #2764

Uh oh!

cvvergara commented Feb 27, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Feb 27, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Pumpup to 3.8.0 #2764

Pumpup to 3.8.0 #2764

Uh oh!

Conversation

cvvergara commented Feb 27, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Feb 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cvvergara commented Feb 27, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 27, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)