Skip to content

(doc) installation: change sh to bash to run pg_prove_tests.sh - #3168

Merged
cvvergara merged 1 commit into
pgRouting:developfrom
xaemonn:doc-installation-bash
Oct 21, 2026
Merged

cvvergara merged 1 commit into
pgRouting:developfrom
xaemonn:doc-installation-bash

Conversation

@xaemonn

@xaemonn xaemonn commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Fixes #3165 .

Changes proposed in this pull request:

  • The Testing section of the installation page runs the pgTAP script with sh.
  • On Ubuntu sh is dash, which has no pushd, so the script stops at line 22.
  • The script has a bash shebang and the CI workflows already run it with bash,
    so this changes sh to bash on that one line.

Tested on Ubuntu 24.04 (WSL2), PostgreSQL 16: with sh the script fails with
pushd: not found; with bash the full suite runs and ends with Result: PASS.

@pgRouting/admins

Summary by CodeRabbit

  • Documentation
    • Updated testing instructions to run pg_prove_tests.sh with Bash.

@coderabbitai

coderabbitai Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

⚙️ Run configuration
  • Configuration used: Repository UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 9ba06b42-adf5-4186-bc3a-ec9291e733ba
📥 Commits

Reviewing files that changed from the base of the PR and between dc8f66b and aa61922.

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

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: b80fa577-b270-477b-83e0-b25785b7629d
📥 Commits

Reviewing files that changed from the base of the PR and between 2572819 and dc8f66b.

📒 Files selected for processing: 1
  • doc/src/pgRouting-installation.rst

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Walkthrough

The installation testing instructions now run tools/testers/pg_prove_tests.sh with bash instead of sh.

Changes

Installation testing

Layer / File(s) Summary
Update test command
doc/src/pgRouting-installation.rst
The testing instructions invoke the test script with bash instead of sh.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other · Severity of issue fixed: Low

Suggested reviewers: cvvergara

Merge Risk: ⚪ Minimal · up to dc8f6

No actionable merge-blocking risk remains.

Architecture risk: 🔵 Low · up to dc8f6

The change affects 1 system.

Changed systems: doc

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — doc (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in doc/src/pgRouting-installation.rst: Testing now runs tools/testers/pg_prove_tests.sh through bash instead of sh.
Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the documented change from sh to bash for running pg_prove_tests.sh.
Linked Issues check Passed Issue #3165 requires the installation documentation to invoke pg_prove_tests.sh with bash instead of sh. The whole-pull-request summary reports the exact one-line change in `doc/src/pgRouting-in…
Out of Scope Changes check Passed The whole-pull-request summary reports one documentation change: the Testing command changes from sh to bash. This change directly addresses issue #3165. No unrelated changes are reported.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Linked Issues check

Explanation

Issue #3165 requires the installation documentation to invoke pg_prove_tests.sh with bash instead of sh. The whole-pull-request summary reports the exact one-line change in doc/src/pgRouting-installation.rst. This matches the issue requirement and the documented script requirement for Bash.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

A rabbit checks the testing guide,
And sees the Bash command inside.
No sh to trip the script today,
The pgTAP tests can run their way.
The rabbit hops and twitches ears,
Then celebrates with carrots near.

Comment @coderabbitai help to get the list of available commands.

@cvvergara

Copy link
Copy Markdown
Member

Your github actions aren't enabled

@cvvergara cvvergara added the Actions not enabled The github user that is making the PR do not have actions enabled. label Oct 20, 2026
@xaemonn
xaemonn force-pushed the doc-installation-bash branch from dc8f66b to aa61922 Compare October 20, 2026 21:02
@xaemonn

xaemonn commented Oct 20, 2026

Copy link
Copy Markdown
Contributor Author

@cvvergara I've enabled actions on my fork now. All three checks passed here:
https://github.com/xaemonn/pgrouting/actions?query=branch%3Adoc-installation-bash

@cvvergara cvvergara added this to the Release 4.1.0 milestone Oct 21, 2026
@cvvergara cvvergara added Documentation and removed Actions not enabled The github user that is making the PR do not have actions enabled. labels Oct 21, 2026
@cvvergara
cvvergara merged commit 09066f6 into pgRouting:develop Oct 21, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Installation docs: sh ./tools/testers/pg_prove_tests.sh fails on Ubuntu

2 participants