Skip to content

chore(backup): rename EasyDash to EasyEngine Dashboard in messages and docs - #525

Merged
mrrobot47 merged 4 commits into
EasyEngine:developfrom
mrrobot47:chore/rename-easyengine-dashboard
Nov 16, 2026
Merged

mrrobot47 merged 4 commits into
EasyEngine:developfrom
mrrobot47:chore/rename-easyengine-dashboard

Conversation

@mrrobot47

@mrrobot47 mrrobot47 commented Nov 3, 2026 •

Copy link
Copy Markdown
Member

Renames the user-facing "EasyDash" wording to "EasyEngine Dashboard" in site-command, to match EasyEngine/dash-command#3. Targets v4.14.0.

Changed:

  • The rollback warning in src/helper/Site_Backup_Restore.php: "EasyDash API callback failed. Rolling back newly uploaded backup..." is now "EasyEngine Dashboard API callback failed. Rolling back newly uploaded backup..."
  • The --debug line "Captured error for EasyDash: ..." is now "Captured error for EasyEngine Dashboard: ..."
  • The --dash-auth help in ee site backup (src/helper/class-ee-site.php): "For EasyEngine dash use only." is now "For EasyEngine Dashboard use only."
  • The comments and docblocks in Site_Backup_Restore.php that named EasyDash.

Unchanged on purpose (machine-matched or identifiers):

  • the --dash-auth flag and its backup-id:backup-verification-token format
  • the ed-api-url config key and its error message
  • the dash_* properties and methods and the $ed_api_url parameter
  • the API endpoint paths easydash.easydash.doctype.site_backup.site_backup.on_ee_backup_success and ...on_ee_backup_failure
  • the existing "EasyEngine Dashboard callback ..." messages in send_dash_request(), which already used the new name

No tests or scripts match the changed strings. php -l passes on PHP 7.4 and 8.5.

Overlap: #481 (backup callback flow) edits the same file on different lines; the two merge cleanly in either order, and #481 uses the new name for the messages it adds.

CI: this PR's own check fails in "Install dependencies" until #524 (Composer advisory ignore) is merged. The same head plus #524's commit passes Behat on PHP 7.4 and 8.0: https://github.com/mrrobot47/site-command/actions/runs/41799734503

Summary by CodeRabbit

  • Documentation
    • Updated backup and restore references, messages, and the --dash-auth option description to use “EasyEngine Dashboard” instead of “EasyDash” or “EasyEngine dash.” No behavior changes.

…d docs

Use the product name in the backup rollback warning, the captured-error debug line, the --dash-auth help text and the related comments and docblocks. The --dash-auth flag, the ed-api-url config key, the dash_* identifiers and the easydash.* API endpoint paths are unchanged.

Copilot AI left a comment

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.

🟢 Approval recommended

No active review issues block approval of the dashboard naming update.

No open issues 🎉

What changed in this PR

Updates site backup wording from “EasyDash” to “EasyEngine Dashboard,” aligning user-facing text with the dashboard naming while preserving behavior and integration identifiers.

Changes:

  • Renames the dashboard in backup warning and debug messages.
  • Updates related comments, docblocks, and --dash-auth help text.
  • Leaves flags, configuration keys, and API endpoint paths unchanged.
File Description
src/​helper/​Site_Backup_Restore.php Updates dashboard naming in messages, comments, and docblocks.
src/​helper/​class-ee-site.php Updates dashboard naming in backup command help.

Review effort: Balanced

mrrobot47 added a commit to mrrobot47/site-command that referenced this pull request Nov 4, 2026
Matches the EasyDash rename in EasyEngine#525 for the strings and comments this PR adds.
@mrrobot47

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Nov 16, 2026 •

Copy link
Copy Markdown
Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai

coderabbitai Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

Changes: EasyEngine Dashboard terminology

Layer / File(s) Summary
Update option description and coverage
src/helper/class-ee-site.php, features/COVERAGE.md
The --dash-auth option description and its coverage scenario now refer to EasyEngine Dashboard.
Update backup and restore callback references
src/helper/Site_Backup_Restore.php
Comments, callback messages, rollback messages, and callback documentation now refer to EasyEngine Dashboard instead of EasyDash. Callback behavior and logged error fields are unchanged.

Change: Other

Merge Risk: Minimal · up to 337e3

This is a terminology-only update to messages, help text, comments, and docs. It does not change runtime behavior and is low risk to merge.

Security architecture risk: Minimal · up to 337e3

The change standardizes Dashboard naming without changing callback behavior, authentication, interfaces, dependencies, or rollback logic. No introduced or worsened architecture risk is established.

Finishing Touches

Generate unit tests (beta)

  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Warning

Some tools did not complete. Review the errors below.

PHPStan (2.3.3)

Composer install failed: dependency resolution error. Check composer.json and composer.lock for version constraints.

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 71d6ece4-aab2-44f2-9ca3-09455dc804d6
Commits

Reviewing files that changed from the base of the PR and between f3dae3a and 337e308.

Files selected for processing: 3

  • features/COVERAGE.md
  • src/helper/Site_Backup_Restore.php
  • src/helper/class-ee-site.php

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 6 remain after this review.

@mrrobot47
mrrobot47 merged commit 4c94311 into EasyEngine:develop Nov 16, 2026
23 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.

2 participants