Skip to content

Update readme#978

Merged
gaoxueyu merged 2 commits intoIvorySQL:masterfrom
jiaoshuntian:update_readme
Nov 25, 2025
Merged

Update readme#978
gaoxueyu merged 2 commits intoIvorySQL:masterfrom
jiaoshuntian:update_readme

Conversation

@jiaoshuntian
Copy link
Copy Markdown
Collaborator

@jiaoshuntian jiaoshuntian commented Nov 25, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Documentation
    • Updated installation guidance and Quick Start links to reference v5.0 documentation across English and Chinese README files.
    • Added information about developer formatting hooks and CI workflow requirements.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Nov 25, 2025 •
edited
Loading

Walkthrough

This PR updates installation and quick-start documentation links in both English and Chinese README files from v4.5 to v5.0 references. It also adds information about pre-commit hook dependencies and a Cirrus CI workflow for code formatting checks.

Changes

Cohort / File(s) Change Summary
Documentation Version Bumps
README.md, README_CN.md		 Updated all installation documentation links and quick-start references from v4.5 (or v4.5/6) to v5.0, including updates to Yum, Docker, RPM, and source code installation anchors.
Developer Tooling Information
README.md		 Added documentation detailing pre-commit hook dependencies under Developer Formatting hooks section and noted Cirrus CI FormatCheck workflow for pgindent validation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Simple, repetitive link replacement pattern (v4.5 → v5.0) across both files
  • Minor additions of CI/developer tool documentation with no complex logic
  • Consistent formatting updates with no structural changes

Possibly related PRs

  • update readme for 4.5 release #813: Version bump PR that updated README links from v4.4 to v4.5 using the same link-update pattern across README.md and README_CN.md.
  • Add readme_cn #762: Initial introduction of the Chinese README (README_CN.md) and language selector infrastructure that this PR now maintains through version updates.

Poem

🐰 Links updated, v5 arrives,
Documentation thrives and comes alive,
Chinese and English, side by side,
Version bumps with formatting pride! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Update readme' is vague and generic, using non-descriptive language that doesn't convey specific information about what was changed in the README files. Consider a more specific title such as 'Update documentation links from v4.5 to v5.0' or 'Update installation links and add CI workflow documentation'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0a43e33 and a2f841f.

📒 Files selected for processing (2)
  • README.md (1 hunks)
  • README_CN.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
  • GitHub Check: pg_regression (ubuntu-latest)
  • GitHub Check: meson_build (ubuntu-latest)
  • GitHub Check: oracle_regression (ubuntu-latest)
  • GitHub Check: oracle_pg_regression (ubuntu-latest)
  • GitHub Check: contrib_regression
  • GitHub Check: build (ubuntu-latest)
🔇 Additional comments (3)
README.md (2)

26-32: Documentation links verified—no issues found.

All v5.0 documentation URLs are accessible, and all anchor fragments match the actual documentation structure. The installation section updates are correct.

34-37: All referenced tools and workflows are correctly configured; no issues found.

Verification confirms:

  • .githooks/pre-commit hook exists and is properly configured
  • src/tools/pgindent/ (script) and src/tools/pg_bsd_indent/ (source buildable via Makefile/Meson) exist at specified paths
  • FormatCheck workflow is defined in .cirrus.format.yml and correctly runs pgindent --check on C/C++ files changed in PRs

The README documentation at lines 34–37 accurately describes the pre-commit hook setup and Cirrus CI workflow.

README_CN.md (1)

30-36: Documentation URLs verified as accessible.

The v5.0 release is planned for Q4 2025, and the base documentation URLs you tested both return HTTP 200 status codes, confirming the documentation infrastructure is live and accessible. The update from v4.5 to v5.0 links appears appropriate for the timing.

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

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

@gaoxueyu gaoxueyu merged commit c51d958 into IvorySQL:master Nov 25, 2025
6 checks passed
This was referenced Nov 26, 2025
Merged
Closed
@jiaoshuntian jiaoshuntian deleted the update_readme branch December 8, 2025 07:56
@coderabbitai coderabbitai bot mentioned this pull request Dec 18, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Mar 12, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jiaoshuntian @gaoxueyu