DRCD-1363: Added information to command description when command was … #1947
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds version information to command descriptions across the Acquia CLI codebase, indicating when each command was first introduced. The change appends "(Added in X.Y.Z)" to the description field of the #[AsCommand] attribute for numerous commands.
Key changes:
- Version metadata added to 60+ command descriptions
- Version numbers range from 1.0.0 (earliest commands) to 2.31.0 (newest commands)
- Consistent formatting pattern applied across most commands
Reviewed changes
Copilot reviewed 64 out of 64 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Command/Ssh/SshKey*.php (6 files) | Added version info to SSH key management commands (1.0.0 and 1.17.0) |
| src/Command/Self/*.php (5 files) | Added version info to self-management commands (2.0.0, 2.31.0, and 1.25.0) |
| src/Command/Remote/*.php (4 files) | Added version info to remote commands (all 1.0.0) |
| src/Command/Push/*.php (4 files) | Added version info to push commands (1.1.0 and 1.11.0) |
| src/Command/Pull/*.php (5 files) | Added version info to pull commands (all 1.1.0) |
| src/Command/Ide/*.php (13 files) | Added version info to IDE commands (versions 1.0.0-1.18.0) |
| src/Command/Env/*.php (4 files) | Added version info to environment commands (2.0.0 and 2.10.0) |
| src/Command/CodeStudio/*.php (3 files) | Added version info to Code Studio commands (1.21.0-2.7.0) |
| src/Command/Auth/*.php (4 files) | Added version info to authentication commands (1.1.0 and 2.20.1) |
| src/Command/App/*.php (8 files) | Added version info to application commands (versions 1.23.0-2.14.0) |
| src/Command/Archive/ArchiveExportCommand.php | Added version info (1.12.0) |
| src/Command/Api/ApiListCommand.php | Added version info (1.0.0) |
| src/Command/Acsf/AcsfListCommand.php | Added version info (1.30.1) |
| src/Command/HelloWorldCommand.php | Added version info to test command (1.12.1) |
| src/Command/DocsCommand.php | Added version info (1.18.0) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
src/Command/Env/EnvMirrorCommand.php
Outdated
|
|
||
| #[RequireAuth] | ||
| #[AsCommand(name: 'env:mirror', description: 'Makes one environment identical to another in terms of code, database, files, and configuration.')] | ||
| #[AsCommand(name: 'env:mirror', description: 'Makes one environment identical to another in terms of code, database, files, and configuration. (Added in 2.0.0)')] |
There was a problem hiding this comment.
The version information formatting is inconsistent with other commands. This description should end with a period before the version information to match the pattern used in other commands like "env:certificate-create" and "app:new:from:drupal7".
| #[AsCommand(name: 'env:mirror', description: 'Makes one environment identical to another in terms of code, database, files, and configuration. (Added in 2.0.0)')] | |
| #[AsCommand(name: 'env:mirror', description: 'Makes one environment identical to another in terms of code, database, files, and configuration. Added in 2.0.0.')] |
|
|
||
| #[RequireAuth] | ||
| #[AsCommand(name: 'env:certificate-create', description: 'Install an SSL certificate.')] | ||
| #[AsCommand(name: 'env:certificate-create', description: 'Install an SSL certificate. (Added in 2.10.0)')] |
There was a problem hiding this comment.
The version information formatting is inconsistent with other commands. This description should end with a period before the version information to match the pattern used in other commands. The period after "certificate" should remain, and the version information should be in parentheses after that period.
| #[AsCommand(name: 'env:certificate-create', description: 'Install an SSL certificate. (Added in 2.10.0)')] | |
| #[AsCommand(name: 'env:certificate-create', description: 'Install an SSL certificate. (Added in 2.10.0.)')] |
| use Symfony\Component\Validator\Exception\ValidatorException; | ||
|
|
||
| #[AsCommand(name: 'app:new:from:drupal7', description: 'Generate a new Drupal 9+ project from a Drupal 7 application using the default Acquia Migrate Accelerate recommendations.', aliases: [ | ||
| #[AsCommand(name: 'app:new:from:drupal7', description: 'Generate a new Drupal 9+ project from a Drupal 7 application using the default Acquia Migrate Accelerate recommendations. (Added in 2.14.0)', aliases: [ |
There was a problem hiding this comment.
The version information formatting is inconsistent with other commands. This description should end with a period before the version information to match the pattern used in other commands. The period after "recommendations" should remain, and the version information should be in parentheses after that period.
| #[AsCommand(name: 'app:new:from:drupal7', description: 'Generate a new Drupal 9+ project from a Drupal 7 application using the default Acquia Migrate Accelerate recommendations. (Added in 2.14.0)', aliases: [ | |
| #[AsCommand(name: 'app:new:from:drupal7', description: 'Generate a new Drupal 9+ project from a Drupal 7 application using the default Acquia Migrate Accelerate recommendations. (Added in 2.14.0.)', aliases: [ |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1947 +/- ##
=========================================
Coverage 92.05% 92.05%
Complexity 1894 1894
=========================================
Files 122 122
Lines 6959 6959
=========================================
Hits 6406 6406
Misses 553 553 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Try the dev build for this PR: https://acquia-cli.s3.amazonaws.com/build/pr/1947/acli.phar |
1 participant
…added.
Motivation
Fixes #NNN
Proposed changes
Alternatives considered
Testing steps
./bin/acli ckc