Skip to content
/ app-api Public template
generated from yiisoft/package-template

Port make help grouping from yiisoft/app#267

Merged
samdark merged 3 commits intomasterfrom
copilot/port-grouping-from-yiisoft-app
Mar 5, 2026
Merged

Port make help grouping from yiisoft/app#267
samdark merged 3 commits intomasterfrom
copilot/port-grouping-from-yiisoft-app

Conversation

Copy link
Contributor

Copilot AI commented Mar 5, 2026

Ports yiisoft/app#448 — improves make help output to display targets organized under named section headers instead of a flat list.

Changes

  • Makefile

    • Replaced flat awk help formatter with one that reads # Section comments as group headers
    • Added missing # Tools section grouping yii, composer, rector, cs-fix
    • Added ## ... descriptions to test and test-coverage (previously invisible in make help)
    • Removed PROD | prefix from production target descriptions — group header now carries that context
    • Added trailing periods to all descriptions for consistency
  • docker/.env — simplified section comments from three-line #\n# Section\n# blocks to single # Section lines (required for the new awk parser to detect group boundaries)

  • CHANGELOG.md — added entry for #266

make help output after changes

Usage:
  make <target>

Development
  build                     Build docker images.
  up                        Up the dev environment.
  ...

Tools
  yii                       Execute Yii command.
  composer                  Run Composer.
  ...

Tests and analysis
  test                      Run tests.
  ...

Production
  prod-build                Build an image.
  prod-push                 Push image to repository.
  prod-deploy               Deploy to production.
Original prompt

This section details on the original issue you should resolve

<issue_title>Port grouping in make from yiisoft/app</issue_title>
<issue_description>### Proposed new feature or change

See yiisoft/app#448. That should be ported.</issue_description>

<agent_instructions>Use number 266 for CHANGELOG</agent_instructions>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: samdark <47294+samdark@users.noreply.github.com>
Copilot AI changed the title [WIP] Port grouping feature from yiisoft/app Port make help grouping from yiisoft/app Mar 5, 2026
@samdark samdark marked this pull request as ready for review March 5, 2026 21:57
Copilot AI review requested due to automatic review settings March 5, 2026 21:57
@samdark samdark merged commit 4e31c63 into master Mar 5, 2026
18 checks passed
@samdark samdark deleted the copilot/port-grouping-from-yiisoft-app branch March 5, 2026 21:58
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Ports the grouped make help output format from yiisoft/app so Make targets are displayed under section headers (instead of a flat list), improving usability of developer tooling in this repo.

Changes:

  • Updated Makefile help formatter to print section headers based on # Section comments and standardized target descriptions.
  • Simplified section comment formatting in docker/.env to align with the new help grouping approach.
  • Added a changelog entry for #266 documenting the enhancement.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
Makefile Adds section-based grouping for make help and updates target descriptions for consistent formatting.
docker/.env Collapses multi-line section comment blocks into single # Section lines.
CHANGELOG.md Records the make help grouping enhancement under #266.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +157 to +158
printf " \033[36m%-25s\033[0m %s\n", target, desc; \
blank = 0; \
Copy link

Copilot AI Mar 5, 2026

Choose a reason for hiding this comment

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

The new make help awk parser prints any make rule that matches the target regex, even if it has no ## description. This changes prior behavior (undocumented targets were hidden) and can lead to empty-description entries or noise if other included makefiles contain rules. Consider filtering to only lines containing ## (or skipping when parts[2] is empty) so the help output stays intentional and stable.

Suggested change
printf " \033[36m%-25s\033[0m %s\n", target, desc; \
blank = 0; \
if (desc != "") { \
printf " \033[36m%-25s\033[0m %s\n", target, desc; \
blank = 0; \
} \

Copilot uses AI. Check for mistakes.
@codecov
Copy link

codecov bot commented Mar 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.70%. Comparing base (4f3493a) to head (5b30fee).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##             master     #267   +/-   ##
=========================================
  Coverage     76.70%   76.70%           
  Complexity       52       52           
=========================================
  Files            16       16           
  Lines           176      176           
=========================================
  Hits            135      135           
  Misses           41       41           

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

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.

Port grouping in make from yiisoft/app

3 participants