Skip to content

ci: Install cpp-coveralls from its git repo#586

Merged
stefanberger merged 1 commit into
masterfrom
master.next
Jun 1, 2026
Merged

ci: Install cpp-coveralls from its git repo#586
stefanberger merged 1 commit into
masterfrom
master.next

Conversation

@stefanberger

@stefanberger stefanberger commented Jun 1, 2026

Copy link
Copy Markdown
Owner

Summary by CodeRabbit

  • Chores
    • Updated CI workflow’s coverage tooling setup to change how coverage is sourced and installed, improving reliability of coverage reporting.

Note: This release contains only internal infrastructure updates with no visible changes to end-user functionality.

@coderabbitai

coderabbitai Bot commented Jun 1, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@stefanberger, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 11 minutes and 51 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 06086456-0043-4744-bacb-71267dbc3626

📥 Commits

Reviewing files that changed from the base of the PR and between 0616e70 and ed293df.

📒 Files selected for processing (1)
  • .github/workflows/ci.yml
📝 Walkthrough

Walkthrough

This PR changes the Coveralls CI job to clone the eddyxu/cpp-coveralls repository and install it with pip install -e . instead of using a direct pip install cpp-coveralls.

Changes

CI workflow cpp-coveralls setup

Layer / File(s) Summary
cpp-coveralls installation method
.github/workflows/ci.yml
The Coveralls job now clones the eddyxu/cpp-coveralls repository, installs it in editable mode via pip install -e ., and returns to the parent directory, replacing the prior direct pip install cpp-coveralls approach.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 I hopped to the runner beneath CI's soft light,
Cloned a repo at dusk and made installation right.
pip install -e, a small rabbit cheer,
Coverage tools closer, the logs clear and near.
A tiny change stitched, and the workflow takes flight.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: switching the installation method of cpp-coveralls to use the git repository instead of the default pip package.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ 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 master.next

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

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

65-68: 💤 Low value

Consider adding a comment explaining the installation method.

The PR title indicates this change is intentional, but it would help future maintainers to understand why cpp-coveralls is installed from the git repository instead of from PyPI (e.g., if PyPI version is outdated or has a specific bug that's fixed in the repo).

📝 Example comment
           uidgid="$(id -nu):$(id -ng)"
           sudo chown -R ${uidgid} ./
+          # Install cpp-coveralls from git repository because [reason]
           git clone https://github.com/eddyxu/cpp-coveralls
           pushd cpp-coveralls
            pip install -e .
           popd
🤖 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 @.github/workflows/ci.yml around lines 65 - 68, Add an inline comment above
the git clone / pip install block that explains why cpp-coveralls is installed
from the GitHub repo rather than from PyPI (e.g., PyPI is outdated, a bugfix on
master is required, or a specific commit is needed), and include the rationale
and optionally the commit/PR/issue reference; update the block containing the
commands "git clone https://github.com/eddyxu/cpp-coveralls" and "pip install -e
." to include that explanatory comment so future maintainers understand the
intent.
🤖 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 @.github/workflows/ci.yml:
- Around line 65-68: Because set +e is active, the git clone and pip install
steps can fail silently; modify the block containing the commands git clone
https://github.com/eddyxu/cpp-coveralls, pushd cpp-coveralls, pip install -e .,
and popd so failures abort immediately: either re-enable strict error handling
(set -e) for that block or append explicit checks (e.g., run each command with
|| { echo "Failed to <action>"; exit 1; }) after git clone and pip install so
any error prints a clear message and exits before proceeding to the
cpp-coveralls invocation.
- Line 65: The workflow currently runs an unpinned clone via the command "git
clone https://github.com/eddyxu/cpp-coveralls"; change this to pin to a specific
commit or tag to ensure reproducible CI results by replacing the clone with
either a shallow, pinned clone (e.g., use "git clone --depth 1 --branch
<tag-or-branch> https://github.com/eddyxu/cpp-coveralls" and set <tag-or-branch>
to a tested tag/commit) or switch to the upstream-recommended pip install and
pin the package version (e.g., "pip install cpp-coveralls==<version>"); update
the CI step that contains the git clone invocation accordingly.

---

Nitpick comments:
In @.github/workflows/ci.yml:
- Around line 65-68: Add an inline comment above the git clone / pip install
block that explains why cpp-coveralls is installed from the GitHub repo rather
than from PyPI (e.g., PyPI is outdated, a bugfix on master is required, or a
specific commit is needed), and include the rationale and optionally the
commit/PR/issue reference; update the block containing the commands "git clone
https://github.com/eddyxu/cpp-coveralls" and "pip install -e ." to include that
explanatory comment so future maintainers understand the intent.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 455373bd-9f38-4165-b38b-1b921151441d

📥 Commits

Reviewing files that changed from the base of the PR and between 73c3e76 and 4c09897.

📒 Files selected for processing (1)
  • .github/workflows/ci.yml

Comment thread .github/workflows/ci.yml
Comment thread .github/workflows/ci.yml
Comment on lines +65 to +68
git clone https://github.com/eddyxu/cpp-coveralls
pushd cpp-coveralls
pip install -e .
popd

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 | 🟠 Major | ⚡ Quick win

Add error handling for the installation steps.

Since set +e is still active from line 58, failures during the git clone or pip install will not exit the script. This means if the installation fails, the script will continue to line 69 where cpp-coveralls will fail with a less clear error message.

🛡️ Proposed fix to add error handling
           uidgid="$(id -nu):$(id -ng)"
           sudo chown -R ${uidgid} ./
+          set -e
           git clone https://github.com/eddyxu/cpp-coveralls
           pushd cpp-coveralls
            pip install -e .
           popd
+          set +e
           cpp-coveralls -b src -e tests -e swtpm --gcov-options '\-lp'

This ensures that any failure in the installation steps will cause an immediate exit with a clear error, rather than continuing to the cpp-coveralls invocation.

🤖 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 @.github/workflows/ci.yml around lines 65 - 68, Because set +e is active, the
git clone and pip install steps can fail silently; modify the block containing
the commands git clone https://github.com/eddyxu/cpp-coveralls, pushd
cpp-coveralls, pip install -e ., and popd so failures abort immediately: either
re-enable strict error handling (set -e) for that block or append explicit
checks (e.g., run each command with || { echo "Failed to <action>"; exit 1; })
after git clone and pip install so any error prints a clear message and exits
before proceeding to the cpp-coveralls invocation.

Install cpp-coveralls from its git repo to avoid having to use an old
version of setuptools and to get it to work again.

Signed-off-by: Stefan Berger <stefanb@linux.ibm.com>
@stefanberger stefanberger merged commit 06ec934 into master Jun 1, 2026
5 checks passed
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