Skip to content

chore: README.md [skip-release]#52

Merged
RambokDev merged 1 commit intomainfrom
chore/readme
Apr 1, 2026
Merged

chore: README.md [skip-release]#52
RambokDev merged 1 commit intomainfrom
chore/readme

Conversation

@RambokDev
Copy link
Copy Markdown
Contributor

@RambokDev RambokDev commented Apr 1, 2026

Summary by CodeRabbit

  • Documentation
    • Updated contact email addresses for security vulnerability reporting and code of conduct violation submissions.
    • Added official Helm Chart badge and updated documentation to clearly reflect Kubernetes and Helm installation support availability.
    • Expanded supported technology badges in project documentation to include additional database platforms and infrastructure options.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 1, 2026

📝 Walkthrough

Walkthrough

Contact email addresses were updated from the old domain to a new domain across governance documents. Additionally, the README was enhanced with new badges and updated Helm Chart installation information, replacing a "soon" placeholder with concrete documentation links.

Changes

Cohort / File(s) Summary
Governance & Contact Information
.github/CODE_OF_CONDUCT.md, .github/SECURITY.md
Updated enforcement and security reporting contact email from contact@soluce-technologies.com to contact@portabase.io.
Documentation & Badges
README.md
Added Helm Chart and Firebird badges, reordered Valkey badge, updated Kubernetes/Helm installation from "(soon)" to a concrete Helm link with documentation reference.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 A rabbit hops through with glee,
New contact paths, as plain as can be,
Badges gleam in the README light,
Helm charts and Firebird, oh what a sight!
From old domains to portabase we bound. ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The pull request title is vague and overly broad. While it mentions README.md, it doesn't specify what changes were made (badge updates, documentation links, reordering). Use a more descriptive title like 'chore: Add Helm chart badge and update installation documentation' to clearly convey the main changes.
✅ 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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/readme

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.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/SECURITY.md:
- Line 21: The review notes indicate README.md changes were referenced in the PR
title/summary but the README.md file was not included in the diff; locate the
README.md expected update (the file named README.md) and either add the missing
file changes to this PR or amend the PR description to remove the README claim;
ensure the commit(s) that modified README.md are pushed to the branch so
reviewers can see the actual changes and update the PR title/summary
accordingly.

In `@README.md`:
- Line 57: The list item "Kubernetes with Helm
[details](https://portabase.io/docs/agent/setup#helm)" is missing the leading
dash and should match the other list entries; update the README list entry by
adding the dash before "Kubernetes with Helm [details](...)" so the item reads
consistently with the other installation options.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 898f0223-4a3b-4cdf-bdad-f78be56945b3

📥 Commits

Reviewing files that changed from the base of the PR and between 25c9510 and 1497d23.

📒 Files selected for processing (3)
  • .github/CODE_OF_CONDUCT.md
  • .github/SECURITY.md
  • README.md


1. **Contact Us**
Please report the vulnerability by emailing **[contact@soluce-technologies.com](mailto:contact@soluce-technologies.com)**. Include the following details:
Please report the vulnerability by emailing **[contact@portabase.io](mailto:contact@portabase.io)**. Include the following details:
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Note: README.md file not included in review.

The PR title indicates "chore: README.md [skip-release]" and the AI summary mentions that "the README was enhanced with new badges and updated Helm Chart installation information", but the README.md file was not provided for review.

If README.md was also modified in this PR, please ensure it is included in the review.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/SECURITY.md at line 21, The review notes indicate README.md changes
were referenced in the PR title/summary but the README.md file was not included
in the diff; locate the README.md expected update (the file named README.md) and
either add the missing file changes to this PR or amend the PR description to
remove the README claim; ensure the commit(s) that modified README.md are pushed
to the branch so reviewers can see the actual changes and update the PR
title/summary accordingly.

- Automated CLI (recommended) - [details](https://portabase.io/docs/agent/setup#cli)
- Docker Compose setup - [details](https://portabase.io/docs/agent/setup#docker)
- Kubernetes with Helm (soon)
- Kubernetes with Helm [details](https://portabase.io/docs/agent/setup#helm)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix formatting inconsistency in the list item.

The Helm installation list item is missing a dash before [details], making it inconsistent with the other installation options (lines 55, 56, 58).

📝 Proposed fix for consistent formatting
-- Kubernetes with Helm [details](https://portabase.io/docs/agent/setup#helm)
+- Kubernetes with Helm - [details](https://portabase.io/docs/agent/setup#helm)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- Kubernetes with Helm [details](https://portabase.io/docs/agent/setup#helm)
- Kubernetes with Helm - [details](https://portabase.io/docs/agent/setup#helm)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 57, The list item "Kubernetes with Helm
[details](https://portabase.io/docs/agent/setup#helm)" is missing the leading
dash and should match the other list entries; update the README list entry by
adding the dash before "Kubernetes with Helm [details](...)" so the item reads
consistently with the other installation options.

@RambokDev RambokDev merged commit 8eab97a into main Apr 1, 2026
2 checks passed
@RambokDev RambokDev deleted the chore/readme branch April 1, 2026 15:24
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant