Cleanup readme and update helm to point to new container registry#1663
Merged
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
💤 Files with no reviewable changes (1)
✅ Files skipped from review due to trivial changes (1)
WalkthroughRelease 2.8.1 prep: README hero/quickstart and UI access guidance updated; CLI help/about text reformatted; Helm Chart.yaml bumped and icon/description changed; values.yaml image repo switched to quay.io; index.yaml regenerated with new parseable and parseable-enterprise versions and updated timestamps. ChangesRelease 2.8.1 Packaging
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
index.yaml (1)
91-105:⚠️ Potential issue | 🟠 Major | ⚡ Quick winDo not rewrite digests for already-published chart versions.
The digest changed for
parseable-2.7.2.tgzandparseable-enterprise-2.8.0.tgzeven though their URLs and versions did not. That means the index now claims different bytes for artifacts that should be immutable once published, which can break Helm cache integrity and reproducibility. Please restore the previously published digests or regenerate the index from a clean release artifact set that only adds the new versions.Also applies to: 1715-1729
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@index.yaml` around lines 91 - 105, The index.yaml shows mutated digest fields for published artifacts (e.g., the digest entry for parseable-2.7.2.tgz and parseable-enterprise-2.8.0.tgz were changed); revert those digest values in the digest YAML key back to the original published checksums, or regenerate the entire index.yaml from the canonical set of release artifacts so only new versions are appended (do not alter existing entries). Locate the digest values in the index document (look for the digest: field under the parseable entries and the associated apiVersion/appVersion/dependencies blocks) and restore the original digests or re-run the index generation against the clean artifact tarballs so the index maintains immutable artifact checksums.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 83-89: The heading "Verify images" is misleading because the
example uses the gh attestation verify command with a local artifact path ("gh
attestation verify PATH/TO/YOUR/PARSEABLE/ARTIFACT-BINARY -R
parseablehq/parseable"); update the README to either rename the section to
"Verify artifacts" or "Verify binaries/artifacts" to match that command, or keep
the "Verify images" title and add an OCI image example showing how to verify an
image reference (for example using an image reference in place of
PATH/TO/YOUR/PARSEABLE/ARTIFACT-BINARY with gh attestation verify); ensure the
section text and the example command are consistent with the chosen workflow.
- Line 79: The contributors image lacks accessible alt text; update the <img>
tag in README.md (the line with <img
src="https://contrib.rocks/image?repo=parseablehq/parseable" />) to include a
descriptive alt attribute such as alt="Contributors to parseable on GitHub" so
the badge is announced properly by screen readers; keep the surrounding <a> tag
unchanged.
- Around line 4-5: The README's hero logo uses invalid raw.githubusercontent.com
paths with "/refs/heads/main/..." so update both the light-theme srcset
attribute and the fallback <img> src attribute to the canonical raw URL format
"/<owner>/<repo>/main/<path>" (i.e., replace "/refs/heads/main/" with "/main/")
for the elements referenced as the srcset and the <img> src to restore correct
image rendering.
---
Outside diff comments:
In `@index.yaml`:
- Around line 91-105: The index.yaml shows mutated digest fields for published
artifacts (e.g., the digest entry for parseable-2.7.2.tgz and
parseable-enterprise-2.8.0.tgz were changed); revert those digest values in the
digest YAML key back to the original published checksums, or regenerate the
entire index.yaml from the canonical set of release artifacts so only new
versions are appended (do not alter existing entries). Locate the digest values
in the index document (look for the digest: field under the parseable entries
and the associated apiVersion/appVersion/dependencies blocks) and restore the
original digests or re-run the index generation against the clean artifact
tarballs so the index maintains immutable artifact checksums.
🪄 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: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 987329e2-bde7-44e1-862e-c417a715dc97
📒 Files selected for processing (9)
README.mdhelm-releases/parseable-2.8.1.tgzhelm-releases/parseable-enterprise-2.8.0.tgzhelm-releases/parseable-enterprise-2.8.1.tgzhelm/Chart.yamlhelm/values.yamlindex.yamlscripts/kafka_log_stream_generator.pysrc/cli.rs
Comment on lines
+83
to
89
| ## Verify images | ||
|
|
||
| Parseable builds are attested for build provenance and integrity using the [attest-build-provenance](https://github.com/actions/attest-build-provenance) action. The attestations can be verified by having the latest version of [GitHub CLI](https://github.com/cli/cli/releases/latest) installed in your system. Then, execute the following command: | ||
|
|
||
| ```sh | ||
| gh attestation verify PATH/TO/YOUR/PARSEABLE/ARTIFACT-BINARY -R parseablehq/parseable | ||
| ``` |
Contributor
There was a problem hiding this comment.
Make the verification section match what the command actually verifies.
The section is titled "Verify images", but the example verifies a local artifact/binary path. That sends readers down the wrong workflow unless you either rename the section or add an OCI image example here.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 83 - 89, The heading "Verify images" is misleading
because the example uses the gh attestation verify command with a local artifact
path ("gh attestation verify PATH/TO/YOUR/PARSEABLE/ARTIFACT-BINARY -R
parseablehq/parseable"); update the README to either rename the section to
"Verify artifacts" or "Verify binaries/artifacts" to match that command, or keep
the "Verify images" title and add an OCI image example showing how to verify an
image reference (for example using an image reference in place of
PATH/TO/YOUR/PARSEABLE/ARTIFACT-BINARY with gh attestation verify); ensure the
section text and the example command are consistent with the chosen workflow.
Contributor
There was a problem hiding this comment.
♻️ Duplicate comments (3)
README.md (3)
79-79:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAdd alt text to the contributors image.
Line 79 still has an unlabeled image (
<img ... />withoutalt), which is an accessibility regression.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` at line 79, The contributors badge image in the README uses an <img ... /> tag without alt text, causing an accessibility regression; update the <img> tag inside the contributors link (the <a href="https://github.com/parseablehq/parseable/graphs/contributors"> block) to include a meaningful alt attribute (for example alt="Contributors to parseable on GitHub") so the image is properly labeled for screen readers.
4-5:⚠️ Potential issue | 🟠 Major | ⚡ Quick winFix broken raw GitHub logo URLs (still unresolved).
Line 4 and Line 5 still use
.../refs/heads/main/...inraw.githubusercontent.comlinks. Use the canonical.../<owner>/<repo>/main/<path>format so the logo renders reliably.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 4 - 5, The README uses raw.githubusercontent.com URLs with "refs/heads/main" which breaks rendering; update both the srcset attribute and the img src attribute to the canonical raw URL format raw.githubusercontent.com/<owner>/<repo>/main/<path> (e.g., replace "raw.githubusercontent.com/parseablehq/.github/refs/heads/main/images/logo.svg" with "raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg") so the logo image loads reliably; ensure you change the URL in the <source> srcset and the <img> src attributes.
83-89:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAlign section title with verification command.
Line 83 says “Verify images”, but Line 88 verifies a local artifact binary path. Rename the heading (e.g., “Verify artifacts”) or add an OCI image verification example.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 83 - 89, The section heading "Verify images" is inconsistent with the verify command that targets a local artifact binary ("gh attestation verify PATH/TO/YOUR/PARSEABLE/ARTIFACT-BINARY -R parseablehq/parseable"); update the README by either renaming the heading to "Verify artifacts" (or "Verify artifacts/images") to match the existing command or add an additional OCI image example showing how to run "gh attestation verify" against an image reference so the heading "Verify images" is accurate; ensure you update the heading text "Verify images" and the example block accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Duplicate comments:
In `@README.md`:
- Line 79: The contributors badge image in the README uses an <img ... /> tag
without alt text, causing an accessibility regression; update the <img> tag
inside the contributors link (the <a
href="https://github.com/parseablehq/parseable/graphs/contributors"> block) to
include a meaningful alt attribute (for example alt="Contributors to parseable
on GitHub") so the image is properly labeled for screen readers.
- Around line 4-5: The README uses raw.githubusercontent.com URLs with
"refs/heads/main" which breaks rendering; update both the srcset attribute and
the img src attribute to the canonical raw URL format
raw.githubusercontent.com/<owner>/<repo>/main/<path> (e.g., replace
"raw.githubusercontent.com/parseablehq/.github/refs/heads/main/images/logo.svg"
with "raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg") so
the logo image loads reliably; ensure you change the URL in the <source> srcset
and the <img> src attributes.
- Around line 83-89: The section heading "Verify images" is inconsistent with
the verify command that targets a local artifact binary ("gh attestation verify
PATH/TO/YOUR/PARSEABLE/ARTIFACT-BINARY -R parseablehq/parseable"); update the
README by either renaming the heading to "Verify artifacts" (or "Verify
artifacts/images") to match the existing command or add an additional OCI image
example showing how to run "gh attestation verify" against an image reference so
the heading "Verify images" is accurate; ensure you update the heading text
"Verify images" and the example block accordingly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 557d2d98-7a33-44df-a45f-b7aaf367110e
📒 Files selected for processing (7)
README.mdhelm-releases/parseable-2.8.1.tgzhelm-releases/parseable-enterprise-2.8.1.tgzhelm/Chart.yamlhelm/values.yamlindex.yamlsrc/cli.rs
✅ Files skipped from review due to trivial changes (2)
- helm/Chart.yaml
- src/cli.rs
🚧 Files skipped from review as they are similar to previous changes (2)
- helm/values.yaml
- index.yaml
nikhilsinhaparseable
approved these changes
Jun 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
Documentation
Chores