ci: make coveralls work again

[martin-georgiev]

Summary by CodeRabbit

• Chores
  • Improved the process for uploading coverage results with a dedicated action, enhancing error handling and configuration.
  • Updated test coverage reporting to use a consistent output directory.
  • Refined development tooling by adding a new dependency and removing an outdated one.

[coderabbitai]

Walkthrough

The changes update the CI workflow to use the coverallsapp/github-action@v2 for uploading coverage results instead of a manual shell command. Additionally, the composer.json file now includes a new development dependency (deptrac/deptrac) and removes the outdated php-coveralls/php-coveralls dependency. The test coverage report path has also been modified.

Changes

File(s)	Change Summary
.github/workflows/ci.yml	Replaced the shell command upload with coverallsapp/github-action@v2. Updated parameters with a with block, including fail-on-error and base-path.
composer.json	Added "deptrac/deptrac": "^3.0" to require-dev, removed `"php-coveralls/php-coveralls": "^2.7.0" from require-dev, and updated the coverage report path.

Sequence Diagram(s)

sequenceDiagram
    participant Runner as CI Runner
    participant Action as GitHub Action
    participant Coveralls as Coveralls
    Runner->>Runner: Run tests to generate coverage report
    Runner->>Action: Invoke coverallsapp/github-action@v2 with parameters
    Action->>Coveralls: Upload coverage results using GitHub token and settings
    Coveralls-->>Action: Return upload result
    Action-->>Runner: Report completion status

Loading

Poem

I'm a happy rabbit in a codey glen,
Hopping on changes now and then.
With GitHub Actions leading the way,
And fresh dependencies for a brighter day.
Code paths cleared, my whiskers twitch in play!
🐇💻🌟

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 91fd918 and a257b24.

📒 Files selected for processing (2)

• .github/workflows/ci.yml (1 hunks)
• composer.json (2 hunks)

🧰 Additional context used

🪛 actionlint (1.7.4)

.github/workflows/ci.yml

87-87: property "composer-flags" is not defined in object type {calculate-code-coverage: bool; doctrine-orm: string; ignore-php-version: bool; php: number}

(expression)

🔇 Additional comments (3)

composer.json (2)

45-55: Dependency Update for CI Improvements: Ensure New Dev Dependency Integration

The addition of "deptrac/deptrac": "^3.0" in the "require-dev" section aligns well with the updated CI requirements. Similarly, the removal of "php-coveralls/php-coveralls" helps streamline your dependency list given the transition to the Coveralls GitHub Action.

---

75-79: Coverage Report Output Path Update: Consistency Across CI and Local Environments

The test script "run-tests-with-clover" now uses the updated output path './var/logs/test-coverage/clover.xml', which is consistent with the new base path specified in the CI workflow. This enhances consistency across different environments.

.github/workflows/ci.yml (1)

80-87:

❓ Verification inconclusive

Coveralls Action Configuration: Validate Matrix Variable Usage

The new Coveralls action configuration using coverallsapp/github-action@v2 looks well-structured with parameters for github-token, fail-on-error, and base-path. However, the expression for flag-name references ${{ matrix.composer-flags || '*' }}, yet the composer-flags property isn’t defined in your matrix configuration. This might lead to unexpected behavior or warnings. Please verify if you intended to include composer-flags in the matrix; if so, add its definition, or provide a fixed default value to prevent potential issues.

---

🏁 Script executed:

#!/bin/bash
# Search for any reference to "composer-flags" in the CI workflow file to verify its definition.
rg --ignore-case "composer[-_]flags" .github/workflows/ci.yml || echo "No 'composer-flags' found in the workflow file."

Length of output: 612

---

🏁 Script executed:

#!/bin/bash
# Search for the matrix definition of 'composer-flags' in the CI workflow file to verify if it is defined.
rg --ignore-case -A 10 -B 10 "matrix:" .github/workflows/ci.yml | grep -i "composer-flags"

Length of output: 204

---

Matrix Consistency for composer-flags in the Coveralls Step

It appears that the composer-flags property is referenced in several parts of the workflow (e.g., in job names and Composer commands), which indicates it is defined for some matrix configurations. However, in the Coveralls upload step (lines 80–87 of .github/workflows/ci.yml), you’re using an inline fallback expression (${{ matrix.composer-flags || '*' }}). This suggests that, in the context of this specific job, the composer-flags value might not be set consistently.

• Please verify whether the matrix driving this Coveralls step includes an explicit definition for composer-flags.
• If it is meant to be defined, consider removing the fallback for consistency; otherwise, ensure that the default fallback ('*') is intentional and documented.

🧰 Tools

🪛 actionlint (1.7.4)

87-87: property "composer-flags" is not defined in object type {calculate-code-coverage: bool; doctrine-orm: string; ignore-php-version: bool; php: number}

(expression)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 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.

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.

[coveralls]

coverage: 95.677%. first build
when pulling a257b24 on coveralls
into 91fd918 on main.