Skip to content

Conversation

@AlexSkrypnyk
Copy link
Member

@AlexSkrypnyk AlexSkrypnyk commented Jan 8, 2026

Summary by CodeRabbit

  • Chores
    • Refined CI lint/build behavior to avoid unnecessary cache clearing and added explicit dry-run and full-run variants for the linting tool, improving build predictability and faster pipeline runs.
  • Documentation
    • Minor wording and formatting updates across the README to improve clarity and readability.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Jan 8, 2026

Walkthrough

This change removes the --clear-cache flag from Rector invocations in CI workflows and updates the installer tool definitions to add separate Ahoy commands for Rector dry-run and full run (in addition to the existing cache-clear variant). README whitespace/wording was adjusted.

Changes

Cohort / File(s) Summary
CI Workflow Updates
\.circleci/config.yml, \.github/workflows/build-test-deploy.yml
Removed --clear-cache from Rector lint step; Rector now invoked with --dry-run only.
Installer Tooling
.vortex/installer/src/Prompts/Handlers/Tools.php
Expanded Rector Ahoy command list to include distinct dry-run and run entries alongside the existing clear-cache option.
Docs / README
README.md
Line-wrapping and minor wording/formatting adjustments; no behavioral changes.

Sequence Diagram(s)

(omitted — changes are small and do not introduce multi-component control-flow requiring visualization)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

AUTOMERGE

Poem

🐰 I hopped through CI and installer land,

trimmed a cache flag with a tiny hand.
Now dry-runs hum and commands align,
three little routes — tidy and fine.
🥕✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly addresses the main change: removing --clear-cache flag from Rector commands in CI configuration files, which is reflected across the CircleCI config, GitHub Actions workflow, and related tool definitions.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings

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

Copy link

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.vortex/installer/src/Prompts/Handlers/Tools.php (1)

162-162: Critical typo: 'goups' should be 'groups'.

This typo will cause a runtime error when attempting to retrieve group definitions, as the key 'goups' does not exist in the map.

🐛 Proposed fix
-    $config = static::getToolDefinitions('goups')[$name];
+    $config = static::getToolDefinitions('groups')[$name];
🤖 Fix all issues with AI agents
In @.vortex/installer/src/Prompts/Handlers/Tools.php:
- Around line 235-239: The 'ahoy' array in Tools.php is missing a trailing comma
and should include the three expanded Rector command variants to match CI
changes; update the 'ahoy' => [...] entry (the array assigned to the 'ahoy' key)
by adding a trailing comma after the last string element and confirm the array
contains the three entries 'ahoy cli vendor/bin/rector --clear-cache --dry-run',
'ahoy cli vendor/bin/rector --dry-run', and 'ahoy cli vendor/bin/rector' so the
CLI/CI expansions remain consistent.
📜 Review details

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d6e1589 and 35eea19.

⛔ Files ignored due to path filters (20)
  • .vortex/installer/tests/Fixtures/handler_process/_baseline/.github/workflows/build-test-deploy.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/ciprovider_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/deploy_types_all_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/deploy_types_none_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/deps_updates_provider_ci_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/timezone_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_groups_no_be_lint/.ahoy.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_groups_no_be_lint/.github/workflows/build-test-deploy.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_groups_no_be_lint_circleci/.ahoy.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_groups_no_be_tests_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_no_behat_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_no_phpcs_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_no_phpmd/.github/workflows/build-test-deploy.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_no_phpmd_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_no_phpstan/.github/workflows/build-test-deploy.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_no_phpstan_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_no_phpunit_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_no_rector/.github/workflows/build-test-deploy.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_none/.ahoy.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_none/.github/workflows/build-test-deploy.yml is excluded by !.vortex/installer/tests/Fixtures/**
📒 Files selected for processing (3)
  • .circleci/config.yml
  • .github/workflows/build-test-deploy.yml
  • .vortex/installer/src/Prompts/Handlers/Tools.php
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-11-24T21:29:10.896Z
Learnt from: CR
Repo: drevops/vortex PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-24T21:29:10.896Z
Learning: Use 'ahoy' command prefix for all local development commands instead of running commands directly

Applied to files:

  • .vortex/installer/src/Prompts/Handlers/Tools.php
📚 Learning: 2025-09-13T04:14:41.765Z
Learnt from: AlexSkrypnyk
Repo: drevops/vortex PR: 2011
File: .vortex/tests/phpunit/Traits/Steps/StepAhoyTrait.php:20-23
Timestamp: 2025-09-13T04:14:41.765Z
Learning: In .vortex/tests/phpunit PHPUnit tests using cmd/cmdFail helpers, patterns in the expected output arrays support '*' markers for positive assertions (text must be present) and '!' markers for negative assertions (text must NOT be present). The '*' markers are NOT literal text matches but rather indicate expected presence.

Applied to files:

  • .vortex/installer/src/Prompts/Handlers/Tools.php
🪛 GitHub Actions: Vortex - Test installer
.vortex/installer/src/Prompts/Handlers/Tools.php

[warning] 238-238: A comma should follow the last multiline array item. Found: 'ahoy cli vendor/bin/rector' (Drupal.Arrays.Array.CommaLastItem)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)
  • GitHub Check: build (0)
  • GitHub Check: build (1)
  • GitHub Check: vortex-test-workflow (4)
  • GitHub Check: vortex-test-workflow (3)
  • GitHub Check: vortex-test-workflow (2)
  • GitHub Check: vortex-test-workflow (1)
  • GitHub Check: vortex-test-workflow (0)
🔇 Additional comments (2)
.circleci/config.yml (1)

314-314: LGTM! Rector command updated correctly.

The removal of --clear-cache aligns with the PR objective and maintains the --dry-run flag for linting purposes in CI.

.github/workflows/build-test-deploy.yml (1)

303-303: LGTM! Consistent with CircleCI configuration.

The removal of --clear-cache is consistent with the corresponding change in .circleci/config.yml and aligns with the PR objective.

@github-actions

This comment has been minimized.

@AlexSkrypnyk
Copy link
Member Author

Code Coverage Report:
  2026-01-08 07:24:38

 Summary:
  Classes:  0.00% (0/1)
  Methods:  0.00% (0/2)
  Lines:   93.82% (167/178)

@AlexSkrypnyk
Copy link
Member Author

Code Coverage Report:
  2026-01-08 07:27:36

 Summary:
  Classes:  0.00% (0/1)
  Methods:  0.00% (0/2)
  Lines:   93.82% (167/178)

@AlexSkrypnyk
Copy link
Member Author

Code Coverage Report:
  2026-01-08 07:27:58

 Summary:
  Classes:  0.00% (0/1)
  Methods:  0.00% (0/2)
  Lines:   93.82% (167/178)

@codecov
Copy link

codecov bot commented Jan 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.22%. Comparing base (d6e1589) to head (ba4a4bb).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #2223       +/-   ##
===========================================
- Coverage   99.37%   76.22%   -23.15%     
===========================================
  Files           7      105       +98     
  Lines         159     5687     +5528     
  Branches       44        0       -44     
===========================================
+ Hits          158     4335     +4177     
- Misses          1     1352     +1351     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@AlexSkrypnyk AlexSkrypnyk force-pushed the feature/fix-rector-in-ci branch from 35eea19 to ba4a4bb Compare January 8, 2026 21:25
@AlexSkrypnyk AlexSkrypnyk enabled auto-merge (rebase) January 8, 2026 21:25
Copy link

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.vortex/installer/src/Prompts/Handlers/Tools.php (1)

162-162: Fix typo causing runtime error.

The method call uses 'goups' instead of 'groups', which will cause a fatal error when attempting to access an undefined array key during group processing.

🐛 Proposed fix
-    $config = static::getToolDefinitions('goups')[$name];
+    $config = static::getToolDefinitions('groups')[$name];
🤖 Fix all issues with AI agents
In @README.md:
- Line 124: Remove the redundant phrase "over time" from the sentence containing
"a practical example of how the template evolves over time" so it reads "a
practical example of how the template evolves"; update the sentence text
accordingly in README.md where that exact string appears.
- Line 72: Wrap the bare URL on the line containing "found at
https://vortex-docs.netlify.app/install" in angle brackets so it becomes
<https://vortex-docs.netlify.app/install> to comply with Markdown style and
ensure proper link rendering.
📜 Review details

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 35eea19 and ba4a4bb.

⛔ Files ignored due to path filters (20)
  • .vortex/installer/tests/Fixtures/handler_process/_baseline/.github/workflows/build-test-deploy.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/ciprovider_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/deploy_types_all_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/deploy_types_none_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/deps_updates_provider_ci_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/timezone_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_groups_no_be_lint/.ahoy.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_groups_no_be_lint/.github/workflows/build-test-deploy.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_groups_no_be_lint_circleci/.ahoy.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_groups_no_be_tests_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_no_behat_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_no_phpcs_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_no_phpmd/.github/workflows/build-test-deploy.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_no_phpmd_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_no_phpstan/.github/workflows/build-test-deploy.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_no_phpstan_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_no_phpunit_circleci/.circleci/config.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_no_rector/.github/workflows/build-test-deploy.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_none/.ahoy.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/tools_none/.github/workflows/build-test-deploy.yml is excluded by !.vortex/installer/tests/Fixtures/**
📒 Files selected for processing (4)
  • .circleci/config.yml
  • .github/workflows/build-test-deploy.yml
  • .vortex/installer/src/Prompts/Handlers/Tools.php
  • README.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-09-13T04:14:41.765Z
Learnt from: AlexSkrypnyk
Repo: drevops/vortex PR: 2011
File: .vortex/tests/phpunit/Traits/Steps/StepAhoyTrait.php:20-23
Timestamp: 2025-09-13T04:14:41.765Z
Learning: In .vortex/tests/phpunit PHPUnit tests using cmd/cmdFail helpers, patterns in the expected output arrays support '*' markers for positive assertions (text must be present) and '!' markers for negative assertions (text must NOT be present). The '*' markers are NOT literal text matches but rather indicate expected presence.

Applied to files:

  • .vortex/installer/src/Prompts/Handlers/Tools.php
🪛 LanguageTool
README.md

[style] ~124-~124: This phrase is redundant. Consider writing “evolves”.
Context: ...a practical example of how the template evolves over time. ## Support We provide paid support f...

(EVOLVE_OVER_TIME)

🪛 markdownlint-cli2 (0.18.1)
README.md

72-72: Bare URL used

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (12)
  • GitHub Check: build (1)
  • GitHub Check: build (0)
  • GitHub Check: vortex-test-workflow (3)
  • GitHub Check: vortex-test-workflow (0)
  • GitHub Check: vortex-test-workflow (4)
  • GitHub Check: vortex-test-workflow (1)
  • GitHub Check: vortex-test-workflow (2)
  • GitHub Check: vortex-test-common
  • GitHub Check: vortex-test-installer (8.4)
  • GitHub Check: vortex-test-installer (8.2)
  • GitHub Check: vortex-test-installer (8.3)
  • GitHub Check: main
🔇 Additional comments (3)
.github/workflows/build-test-deploy.yml (1)

303-303: LGTM! Rector cache flag removed as intended.

The change removes the --clear-cache flag while preserving the --dry-run behavior for CI linting. This aligns with the PR objective to fix Rector running in CI.

.circleci/config.yml (1)

314-314: LGTM! Consistent cache flag removal across CI platforms.

The change mirrors the GitHub Actions workflow update, removing --clear-cache while maintaining the dry-run behavior and error handling fallback.

.vortex/installer/src/Prompts/Handlers/Tools.php (1)

235-239: LGTM! Rector command variants properly expanded.

The Ahoy command definitions now include three variants: clear-cache with dry-run, dry-run only, and full execution. This properly supports the removal of --clear-cache from CI while maintaining the ability to clear cache when needed locally.


The latest development version of the installer from `develop` branch can be found at https://vortex-docs.netlify.app/install
The latest development version of the installer from `develop` branch can be
found at https://vortex-docs.netlify.app/install
Copy link

Choose a reason for hiding this comment

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

🧹 Nitpick | 🔵 Trivial

Address markdown style: wrap bare URL.

The bare URL should be wrapped in angle brackets for proper markdown formatting.

📝 Proposed fix
-found at https://vortex-docs.netlify.app/install
+found at <https://vortex-docs.netlify.app/install>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
found at https://vortex-docs.netlify.app/install
found at <https://vortex-docs.netlify.app/install>
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

72-72: Bare URL used

(MD034, no-bare-urls)

🤖 Prompt for AI Agents
In @README.md at line 72, Wrap the bare URL on the line containing "found at
https://vortex-docs.netlify.app/install" in angle brackets so it becomes
<https://vortex-docs.netlify.app/install> to comply with Markdown style and
ensure proper link rendering.


Use this project as a reference for structuring your own Vortex-based site or as a practical example of how the template evolves over time.
Use this project as a reference for structuring your own Vortex-based site or as
a practical example of how the template evolves over time.
Copy link

Choose a reason for hiding this comment

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

🧹 Nitpick | 🔵 Trivial

Remove redundant phrase.

The phrase "evolves over time" is redundant; "evolves" alone conveys the same meaning.

📝 Proposed fix
-a practical example of how the template evolves over time.
+a practical example of how the template evolves.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
a practical example of how the template evolves over time.
a practical example of how the template evolves.
🧰 Tools
🪛 LanguageTool

[style] ~124-~124: This phrase is redundant. Consider writing “evolves”.
Context: ...a practical example of how the template evolves over time. ## Support We provide paid support f...

(EVOLVE_OVER_TIME)

🤖 Prompt for AI Agents
In @README.md at line 124, Remove the redundant phrase "over time" from the
sentence containing "a practical example of how the template evolves over time"
so it reads "a practical example of how the template evolves"; update the
sentence text accordingly in README.md where that exact string appears.

@github-actions
Copy link

github-actions bot commented Jan 8, 2026

Code Coverage Report:
  2026-01-08 21:32:15

 Summary:
  Classes:  0.00% (0/1)
  Methods:  0.00% (0/2)
  Lines:   93.82% (167/178)

@AlexSkrypnyk
Copy link
Member Author

Code Coverage Report:
  2026-01-08 21:32:40

 Summary:
  Classes:  0.00% (0/1)
  Methods:  0.00% (0/2)
  Lines:   93.82% (167/178)

@AlexSkrypnyk
Copy link
Member Author

Code Coverage Report:
  2026-01-08 21:36:33

 Summary:
  Classes:  0.00% (0/1)
  Methods:  0.00% (0/2)
  Lines:   93.82% (167/178)

@AlexSkrypnyk
Copy link
Member Author

Code Coverage Report:
  2026-01-08 21:37:02

 Summary:
  Classes:  0.00% (0/1)
  Methods:  0.00% (0/2)
  Lines:   93.82% (167/178)

@AlexSkrypnyk AlexSkrypnyk disabled auto-merge January 8, 2026 22:28
@AlexSkrypnyk AlexSkrypnyk merged commit 00f6e63 into main Jan 8, 2026
27 of 28 checks passed
@AlexSkrypnyk AlexSkrypnyk deleted the feature/fix-rector-in-ci branch January 8, 2026 22:28
@github-project-automation github-project-automation bot moved this from BACKLOG to Release queue in Vortex Jan 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Release queue

Development

Successfully merging this pull request may close these issues.

2 participants