Skip to content

update document and release pipeline#217

Merged
xiexiaoy merged 1 commit into
eloqdata:mainfrom
xiexiaoy:release-ci
Sep 28, 2025
Merged

update document and release pipeline#217
xiexiaoy merged 1 commit into
eloqdata:mainfrom
xiexiaoy:release-ci

Conversation

@xiexiaoy

@xiexiaoy xiexiaoy commented Sep 28, 2025

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation
    • Updated README download links to the latest packages (v0.2.6) for EloqDoc-RocksDB and EloqDoc-RocksDBCloud on Ubuntu 22.
  • Chores
    • Updated release pipeline branch references and tag handling; no impact on end-user functionality.
    • Minor script adjustments for build process; behavior remains unchanged for users.

@coderabbitai

coderabbitai Bot commented Sep 28, 2025

Copy link
Copy Markdown

Walkthrough

Updates README download URLs; adjusts Concourse pipeline git branches to rel_x_x_x_eloqdoc; modifies build_tarball.bash to skip the git checkout when TAGGED is set, retaining tag detection/validation.

Changes

Cohort / File(s) Summary
Docs: download URLs
README.md
Updated package URLs to versioned tarballs (0.2.6) for EloqDoc-RocksDB and EloqDoc-RocksDBCloud.
CI: pipeline branches
concourse/pipeline/build_release_tarball.yml
Switched multiple git resources from main to rel_x_x_x_eloqdoc; added commented tag_regex; minor EOF newline tidy.
Build: tag handling
concourse/scripts/build_tarball.bash
In TAGGED block, commented out scripts/git-checkout.sh "${TAGGED}" (checkout skipped). Tag detection/validation logic retained.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant Dev as Developer/CI
  participant CI as Concourse Job
  participant Script as build_tarball.bash
  participant Git as Git Repo

  Dev->>CI: Trigger release tarball build
  CI->>Script: Run with TAGGED env (optional)
  Script->>Git: Determine latest tag / validate TAGGED
  alt Prior behavior (before change)
    Script->>Git: Checkout TAGGED commit
    Note over Script: Align repo to TAGGED
  else Current behavior (after change)
    Note over Script: Skips checkout step
  end
  Script->>CI: Proceed to build tarball
  CI-->>Dev: Tarball artifact
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested reviewers

  • lzxddz

Poem

A bunny taps the build with gentle paws,
Toggle branches, skip a checkout—no pause.
New links gleam, 0.2.6 in the sky,
Pipelines hop along, swift and spry.
Tarballs roll out—thump, thump—oh my! 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly captures the two primary areas of change—updating documentation and modifying the release pipeline—without extraneous detail, and it is directly related to the changes in the pull request.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f208149 and 3de8797.

📒 Files selected for processing (3)
  • README.md (2 hunks)
  • concourse/pipeline/build_release_tarball.yml (3 hunks)
  • concourse/scripts/build_tarball.bash (1 hunks)

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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

@xiexiaoy xiexiaoy merged commit 15e6e29 into eloqdata:main Sep 28, 2025
2 checks passed
@xiexiaoy xiexiaoy deleted the release-ci branch September 28, 2025 07:02
zhangh43 pushed a commit to zhangh43/eloqdoc that referenced this pull request Sep 28, 2025
@coderabbitai coderabbitai Bot mentioned this pull request Sep 28, 2025
@coderabbitai coderabbitai Bot mentioned this pull request Oct 16, 2025
@coderabbitai coderabbitai Bot mentioned this pull request Dec 8, 2025
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.

2 participants