docs: update release please release description#154
Conversation
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
github-actions
bot
added
documentation
There was a problem hiding this comment.
Pull request overview
This PR updates MageForge’s CLI theme commands to accept vendor-level theme targeting (and related docs), and adjusts release automation formatting.
Changes:
- Add vendor/prefix theme code expansion support (e.g.,
Vendor→ allVendor/*themes) fortheme:buildandtheme:cleanvia a newAbstractCommandhelper. - Improve
theme:buildsummary output messaging when no themes were successfully built. - Update documentation and release-please PR header formatting.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
src/Console/Command/Theme/CleanCommand.php |
Expands provided theme arguments via vendor/prefix resolution before interactive selection. |
src/Console/Command/Theme/BuildCommand.php |
Adds vendor/prefix resolution for themeCodes and refines the build summary messaging. |
src/Console/Command/AbstractCommand.php |
Introduces resolveVendorThemes() helper to expand vendor-only and wildcard inputs using ThemeList. |
release-please-config.json |
Changes the release-please PR header text to “## Upcoming Release”. |
docs/commands.md |
Documents vendor-name support and adjusts clean usage to indicate multiple arguments. |
| 'themeCodes', | ||
| InputArgument::IS_ARRAY, | ||
| 'Theme codes to build (format: Vendor/theme, Vendor/theme 2, ...)', | ||
| 'Theme codes to build (format: Vendor/theme, Vendor, ...)', |
There was a problem hiding this comment.
The argument help text documents vendor-only inputs (e.g. Vendor) but the command also supports explicit wildcards like Vendor/* via resolveVendorThemes(). Consider updating the help text to mention Vendor/* (or remove wildcard support/comment if it’s not intended) so CLI usage is not misleading.
| 'Theme codes to build (format: Vendor/theme, Vendor, ...)', | |
| 'Theme codes to build (format: Vendor/theme, Vendor, Vendor/*, ...)', |
| // Allow wildcards using the AbstractCommand helper | ||
| if (!empty($themeCodes)) { | ||
| $themeCodes = $this->resolveVendorThemes($themeCodes, $this->themeList); | ||
|
|
||
| // If wildcards matched nothing and no other explicit themes remain |
There was a problem hiding this comment.
The inline comment says this block is for “wildcards”, but resolveVendorThemes() also expands vendor-only inputs (e.g. Vendor). Please adjust the comment to reflect both behaviors to avoid misleading future readers.
| // Allow wildcards using the AbstractCommand helper | |
| if (!empty($themeCodes)) { | |
| $themeCodes = $this->resolveVendorThemes($themeCodes, $this->themeList); | |
| // If wildcards matched nothing and no other explicit themes remain | |
| // Resolve vendor-only inputs and wildcard patterns using the helper | |
| if (!empty($themeCodes)) { | |
| $themeCodes = $this->resolveVendorThemes($themeCodes, $this->themeList); | |
| // If resolution matched no themes and no other explicit themes remain |
| 'themeCodes', | ||
| InputArgument::IS_ARRAY, | ||
| 'Theme codes to clean (format: Vendor/theme, Vendor/theme 2, ...)', | ||
| 'Theme codes to clean (format: Vendor/theme, Vendor, ...)', |
There was a problem hiding this comment.
The argument help text documents vendor-only inputs (e.g. Vendor) but the command also supports explicit wildcards like Vendor/* via resolveVendorThemes(). Consider updating the help text to mention Vendor/* (or remove wildcard support/comment if it’s not intended) so CLI usage is not misleading.
| 'Theme codes to clean (format: Vendor/theme, Vendor, ...)', | |
| 'Theme codes to clean (format: Vendor/theme, Vendor, Vendor/*, ...)', |
| /** | ||
| * Resolve vendor theme codes (e.g., Vendor to all underlying vendor themes) | ||
| * | ||
| * @param array<string> $themeCodes | ||
| * @param ThemeList $themeList | ||
| * @return array<string> | ||
| */ |
There was a problem hiding this comment.
The new helper’s PHPDoc says it resolves vendor theme codes, but the implementation also supports explicit wildcard inputs like Vendor/*. Please update the docblock summary to match the actual supported inputs/behavior.
|
|
||
| ```bash | ||
| bin/magento mageforge:theme:clean [<themename>] | ||
| bin/magento mageforge:theme:clean [<themename>...] |
There was a problem hiding this comment.
In the usage line, the placeholder name <themename> is inconsistent with the actual CLI argument name (themeCodes) used in the command definition and with the build command’s docs. Consider changing it to something like <themeCodes>... for consistency.
| bin/magento mageforge:theme:clean [<themename>...] | |
| bin/magento mageforge:theme:clean [<themeCodes>...] |
| "include-component-in-tag": false, | ||
| "pull-request-title-pattern": "chore: Next Release ${version}", | ||
| "pull-request-header": "## Release ${version}", | ||
| "pull-request-header": "## Upcoming Release", |
There was a problem hiding this comment.
The PR description says this only updates the release-please PR header, but this PR also changes multiple CLI commands and documentation. Please update the PR title/description to reflect the full scope (vendor/wildcard theme code resolution + build summary output) so reviewers understand the risk/intent.
release-please-config.jsonto "## Upcoming Release" for improved clarity.