pumpup to v3.6.3 & fixes #2659

cvvergara · 2024-10-10T01:30:01Z

Fixes #2658

Changes proposed in this pull request:

Build

Explicit minimum requirements:
- postgres 11.0.0
- postgis 3.0.0

Code fixes

Fix warnings from cpplint.
Fix warnings from clang 18.

CI tests

Add a clang tidy test on changed files.
Update test not done on versions: 3.0.1, 3.0.2, 3.0.3, 3.0.4, 3.1.0, 3.1.1,
3.1.2

Documentation

Results of documentation queries adujsted to boost 1.83.0 version:
- pgr_edgeDisjointPaths
- pgr_stoerWagner

pgtap tests

bug fixes

@pgRouting/admins

Summary by CodeRabbit

New Features
- Introduced automation for code quality checks and added manual triggers for CI workflows.
Documentation
- Updated release notes for pgRouting v3.6.3, reflecting revised minimum system requirements.
Tests
- Implemented new tests to ensure consistent code quality during pull requests.
Chores
- Made numerous internal improvements to enhance code clarity, type safety, and overall maintainability.

…++13

coderabbitai · 2025-03-26T17:53:15Z

Caution

Review failed

The pull request is closed.

Walkthrough

This release introduces various updates toward the pgRouting v3.6.3 release. A new Bash script (tidy-vs-commit.sh) has been added to run clang-tidy on modified commit files. Several GitHub workflows now support manual triggering and include updated version arguments, OS matrix modifications, and exclusion rules. The build system and release documentation (including CMakeLists.txt, NEWS.md, and release notes) have been updated to reflect new version and minimum requirement changes. Additionally, various code improvements enhance type safety, reformat control flows, and remove unused variables, while localization and SQL scripts have been updated accordingly.

Changes

File(s)	Change Summary
`.github/scripts/tidy-vs-commit.sh`, `.github/workflows/boost_version.yml`, `.github/workflows/check-queries.yml`, `.github/workflows/clang.yml`, `.github/workflows/tidy-check.yml`, `.github/workflows/ubuntu.yml`, `.github/workflows/update.yml`, `tools/testers/pg_prove_tests.sh`, `tools/scripts/code_checker.sh`	Enhanced CI/CD workflows and automation: added manual triggers, updated version arguments/matrix settings, and improved linting filters; new script for clang-tidy checks on modified files.
`CMakeLists.txt`, `NEWS.md`, `doc/src/release_notes.rst`	Updated project version to 3.6.3 with revised minimum PostgreSQL and PostGIS requirements; added comprehensive release notes.
`docqueries/max_flow/doc-pgr_edgeDisjointPaths.result`, `docqueries/version/doc-full_version.result`, `docqueries/version/doc-version.result`	Adjusted SQL query outputs to increment aggregate cost values and update version information from 3.6.2 to 3.6.3.
Files in `include/`, `src/` (e.g., `include/c_common/debug_macro.h`, `include/chinese/pgr_chinesePostman.hpp`, `include/cpp_common/basic_vertex.h`, `include/dijkstra/drivingDist.hpp`, `include/max_flow/pgr_maximumcardinalitymatching.hpp`, `src/cpp_common/combinations.cpp`, `src/cpp_common/get_check_data.cpp`, `src/driving_distance/.c`, `src/ksp/.c`, `src/max_flow/pgr_maxflow.cpp`, `src/trsp/*.cpp`, `src/withPoints/pgr_withPoints.cpp`)	Improved type safety by replacing C-style casts with `static_cast`, removed unused variables, and reformatted code constructs for enhanced clarity.
Locale files under `locale/` (e.g., `locale/de/LC_MESSAGES/.po`, `locale/en/LC_MESSAGES/.po`, `locale/es/LC_MESSAGES/.po`, `locale/ja/LC_MESSAGES/.po`, `locale/ko/LC_MESSAGES/.po`, `locale/pot/`, `locale/zh_Hans/LC_MESSAGES/*`)	Updated copyright versions and years to reflect the new release (v3.6.3).
`pgtap/mincut/stoerWagner/compare_components.pg`, `tools/developer/translate.sh`	Fixed SQL syntax in CASE statement (changed `END CASE;` to `END;`) and removed the obsolete translation/visualization script.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant Git as Git Repository
    participant Script as tidy-vs-commit.sh
    participant Clang as clang-tidy

    Dev->>Git: Commit changes with modified C/header files
    Git->>Script: Pass base commit hash as argument
    Script->>Git: Compare base commit with HEAD to list modified files
    Script->>Clang: Run clang-tidy on modified C files (with compile commands)
    Script->>Clang: Run clang-tidy on header files (using workaround for headers)
    Clang-->>Script: Return lint results
    Script-->>Dev: Output results or no-issues message

Assessment against linked issues

Objective	Addressed	Explanation
cpplint and clang-tidy integration for code quality [#2658]	✅
Ubuntu matrix update and exclusion of PostgreSQL 11 on ubuntu-latest [#2658]	✅
Boost default on CI and documentation query adjustments (stoerWagner & edgeDisjointPaths) [#2658]	✅
Fix SQL syntax error in pgtap/mincut/stoerWagner/compare_components.pg [#2658]	✅

Possibly related PRs

Fixing docqueries generator flag -level & updating developer tools #2723: Introduces function improvements for clang-tidy integration and automated lint checks, directly related to the new tidy-vs-commit script and CI enhancements.

Poem

Hop, hop—code's in bloom,
My paws tap keys in the room.
Clang-tidy leaps through every file,
Workflows now run with a flexible style.
Bugs hop away on this fine release day,
A joyful bunny sings its code ballet!
🐇✨

📜 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 4f6dff8 and 0570703.

📒 Files selected for processing (46)

.github/scripts/tidy-vs-commit.sh (1 hunks)
.github/workflows/boost_version.yml (3 hunks)
.github/workflows/check-queries.yml (1 hunks)
.github/workflows/clang.yml (1 hunks)
.github/workflows/tidy-check.yml (1 hunks)
.github/workflows/ubuntu.yml (1 hunks)
.github/workflows/update.yml (2 hunks)
CMakeLists.txt (4 hunks)
NEWS.md (1 hunks)
doc/src/release_notes.rst (1 hunks)
docqueries/max_flow/doc-pgr_edgeDisjointPaths.result (6 hunks)
docqueries/version/doc-full_version.result (1 hunks)
docqueries/version/doc-version.result (1 hunks)
include/c_common/debug_macro.h (1 hunks)
include/chinese/pgr_chinesePostman.hpp (0 hunks)
include/cpp_common/basic_vertex.h (1 hunks)
include/dijkstra/drivingDist.hpp (1 hunks)
include/max_flow/pgr_maximumcardinalitymatching.hpp (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 (1 hunks)
locale/es/LC_MESSAGES/index.po (1 hunks)
locale/es/LC_MESSAGES/pgrouting_doc_strings.po (1 hunks)
locale/ja/LC_MESSAGES/index.po (1 hunks)
locale/ja/LC_MESSAGES/pgrouting_doc_strings.po (1 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 (1 hunks)
locale/zh_Hans/LC_MESSAGES/index.po (1 hunks)
locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po (1 hunks)
pgtap/mincut/stoerWagner/compare_components.pg (1 hunks)
src/cpp_common/combinations.cpp (1 hunks)
src/cpp_common/get_check_data.cpp (1 hunks)
src/driving_distance/many_to_dist_driving_distance.c (1 hunks)
src/driving_distance/many_to_dist_withPointsDD.c (1 hunks)
src/ksp/ksp.c (1 hunks)
src/ksp/withPoints_ksp.c (1 hunks)
src/max_flow/pgr_maxflow.cpp (7 hunks)
src/trsp/trspVia_driver.cpp (1 hunks)
src/trsp/trspVia_withPoints_driver.cpp (1 hunks)
src/withPoints/pgr_withPoints.cpp (0 hunks)
tools/developer/translate.sh (0 hunks)
tools/scripts/code_checker.sh (3 hunks)
tools/testers/pg_prove_tests.sh (1 hunks)

✨ 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 plan to trigger planning for file edits and PR creation.
@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.

cvvergara added 3 commits October 9, 2024 15:45

Pump up version to 3.6.3

8368b67

(build) explicitly require postgres 11 as min version

6e65f31

(CI) adding a clang tidy check

5df8af4

cvvergara added Enhancement Build CI Conitnuous Integration labels Oct 10, 2024

cvvergara added this to the Release 3.6.3 milestone Oct 10, 2024

cvvergara requested a review from robe2 October 10, 2024 01:30

cvvergara self-assigned this Oct 10, 2024

cvvergara changed the title ~~Refs/heads/pumpup to v3.6.3~~ pumpup to v3.6.3 & fixes Oct 10, 2024

cvvergara added 10 commits October 9, 2024 19:39

(lint) removing unused developer tool

e5bccc7

(CI) Ignore false positive on code checker script

7ad726b

(CI) adding test for ububtu-22.04

15776dc

(CI) adding workflow_dispatch & some cleanup

4aa8148

(CI) removing update test from versions that could not compile with g…

f2621d8

…++13

(lint) fixing lint errors

b63b605

(CI,docqueries) edgeDisjointPaths results change on 24.04

4fc34a8

(pgtap) fix syntax error

8a975d5

(clang) fixing clang 18 warnings

53801de

(doc) updating release notes and NEWS

0570703

cvvergara force-pushed the pumpup-to-v3.6.3 branch from 97f7f40 to 0570703 Compare October 10, 2024 01:39

robe2 approved these changes Oct 10, 2024

View reviewed changes

cvvergara merged commit 084a843 into pgRouting:main Oct 10, 2024
23 checks passed

cvvergara deleted the pumpup-to-v3.6.3 branch October 10, 2024 02:15

cvvergara mentioned this pull request Oct 10, 2024

Port main 3.6.3 changes to develop 3.7.0 #2660

Merged

cvvergara added Administrative and removed Enhancement labels Mar 26, 2025

coderabbitai bot mentioned this pull request Mar 31, 2025

Issue tbd wrap pg proc test functions #2805

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

pumpup to v3.6.3 & fixes #2659

pumpup to v3.6.3 & fixes #2659

Uh oh!

cvvergara commented Oct 10, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

Uh oh!

coderabbitai bot commented Mar 26, 2025 •

edited

Loading

Review failed

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

pumpup to v3.6.3 & fixes #2659

pumpup to v3.6.3 & fixes #2659

Uh oh!

Conversation

cvvergara commented Oct 10, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

Uh oh!

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

Uh oh!

Review failed

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Possibly related PRs

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

cvvergara commented Oct 10, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 26, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)