Skip to content

Improve CodeScene install step#108

Merged
leynos merged 3 commits intomainfrom
codex/harden-checksum-verification-in-ci-workflow
Jun 12, 2025
Merged

Improve CodeScene install step#108
leynos merged 3 commits intomainfrom
codex/harden-checksum-verification-in-ci-workflow

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 12, 2025

Summary

  • use a stricter CodeScene installation step in CI

Testing

  • cargo fmt -- --check
  • cargo clippy --no-default-features --features sqlite
  • cargo clippy --no-default-features --features postgres
  • cargo test --no-default-features --features sqlite
  • cargo test --no-default-features --features postgres (fails: DatabaseInitializationError)
  • markdownlint docs/*.md
  • nixie docs/*.md

https://chatgpt.com/codex/tasks/task_e_684aad6953688322a18d63a8059a3a6e

Summary by Sourcery

Tighten the CodeScene coverage tool installation in the GitHub Actions CI workflow by enforcing strict shell options, embedding an expected SHA256 checksum, verifying the download, and updating the step name.

CI:

  • Rename CI step to Install CodeScene coverage tool
  • Add strict shell safety flags and verify the install script’s SHA256 checksum via sha256sum

Summary by CodeRabbit

  • Chores
    • Improved reliability and security of the CodeScene coverage tool installation in the CI workflow by updating error handling and checksum verification methods.
  • Documentation
    • Added detailed documentation for using the CodeScene CLI tool in continuous integration, including checksum verification instructions.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 12, 2025

Reviewer's Guide

This PR hardens the CodeScene coverage tool installation step in the CI workflow by adding strict shell safety flags, standardizing the step name, and simplifying checksum verification with sha256sum -c.

Sequence Diagram for the updated 'Install CodeScene coverage tool' CI step interactions

sequenceDiagram
    title "Sequence Diagram for 'Install CodeScene coverage tool' Interactions"
    participant Runner as "GitHub Actions Runner"
    participant Shell as "Shell Environment (CI Step)"
    participant CodeSceneServer as "downloads.codescene.io"

    Runner->>Shell: Execute "Install CodeScene coverage tool" Step
    activate Shell
    Shell->>Shell: Configure shell (`set -euo pipefail`)
    Shell->>CodeSceneServer: Request: Download `install-cs-coverage-tool.sh`
    activate CodeSceneServer
    CodeSceneServer-->>Shell: Response: Script content (`install-cs-coverage-tool.sh`)
    deactivate CodeSceneServer
    Shell->>Shell: Action: Verify checksum using `sha256sum -c -`
    Shell->>Shell: Action: Execute `install-cs-coverage-tool.sh -y`
    Shell-->>Runner: Result: Step Outcome (success or failure based on command exit codes)
    deactivate Shell
Loading

File-Level Changes

Change Details Files
Hardened CodeScene CLI install step in CI
  • Renamed step to “Install CodeScene coverage tool” for clarity
  • Added set -euo pipefail to enforce strict shell error handling
  • Introduced EXPECTED_SHA variable for the known-good checksum
  • Replaced manual SHA256 calculation and if-check with sha256sum -c -
.github/workflows/ci.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 12, 2025

Walkthrough

The GitHub Actions workflow for installing the CodeScene coverage tool was updated. The installation step was renamed for clarity, stricter shell error handling was added, and the SHA256 checksum verification was refactored to use a standard command for improved reliability. Additionally, new documentation for the CodeScene CLI tool and its checksum verification process was added.

Changes

File(s) Change Summary
.github/workflows/ci.yml Renamed install step, added strict shell options, refactored checksum verification method, added environment variable for checksum, and cleaned up install script.
docs/codescene-cli.md Added new documentation describing the CodeScene CLI tool installation and checksum verification process in CI.

Poem

In the warren of CI, we hop with care,
With stricter checks and names laid bare.
Our scripts now guard each download’s fate,
With sums that match and errors that wait.
In every shell, a rabbit’s pride—
Secure and tidy, side by side! 🐇✨


📜 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 b97e260 and c909afc.

📒 Files selected for processing (2)
  • .github/workflows/ci.yml (2 hunks)
  • docs/codescene-cli.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • docs/codescene-cli.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/ci.yml
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: coverage
  • GitHub Check: build-test (postgres)
  • GitHub Check: build-test (sqlite)

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Choose a reason for hiding this comment

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

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

Quality Gate Profile: Pay Down Tech Debt
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey @leynos - I've reviewed your changes and they look great!

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `.github/workflows/ci.yml:59` </location>
<code_context>
-            exit 1
-          fi
+          echo "${EXPECTED_SHA}  install-cs-coverage-tool.sh" | sha256sum -c -
           bash install-cs-coverage-tool.sh -y
       - name: Upload coverage data to CodeScene
         run: cs-coverage upload --format "lcov" --metric "line-coverage" "lcov.info"
</code_context>

<issue_to_address>
Cleanup the downloaded install script after execution

Add 'rm install-cs-coverage-tool.sh' after installation to keep the workspace clean.
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread .github/workflows/ci.yml
exit 1
fi
echo "${EXPECTED_SHA} install-cs-coverage-tool.sh" | sha256sum -c -
bash install-cs-coverage-tool.sh -y
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

suggestion: Cleanup the downloaded install script after execution

Add 'rm install-cs-coverage-tool.sh' after installation to keep the workspace clean.

Copy link
Copy Markdown
Contributor

@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: 0

🧹 Nitpick comments (1)
.github/workflows/ci.yml (1)

56-56: Centralise and document the pinned checksum.
The hard-coded EXPECTED_SHA must be updated whenever the install script changes—consider extracting this into a shared variable or linking to its source/version in documentation.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 56f7245 and b97e260.

📒 Files selected for processing (1)
  • .github/workflows/ci.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: coverage
  • GitHub Check: build-test (sqlite)
  • GitHub Check: build-test (postgres)
🔇 Additional comments (3)
.github/workflows/ci.yml (3)

53-53: Approve renamed step for clarity.
Renaming to "Install CodeScene coverage tool" makes the purpose explicit and improves readability of the workflow.


55-55: Enforce strict shell error handling.
Adding set -euo pipefail ensures the installation script fails fast on errors, undefined variables or pipeline issues.


58-58: Standardise checksum verification approved.
Using echo … | sha256sum -c - leverages the native verifier for a concise, reliable integrity check.

Copy link
Copy Markdown

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Choose a reason for hiding this comment

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

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

Quality Gate Profile: Pay Down Tech Debt
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

Copy link
Copy Markdown

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Choose a reason for hiding this comment

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

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

Quality Gate Profile: Pay Down Tech Debt
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

@leynos leynos merged commit 653d07d into main Jun 12, 2025
3 of 5 checks passed
@leynos leynos deleted the codex/harden-checksum-verification-in-ci-workflow branch June 12, 2025 11:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant