Merge branch 'main' into copilot/add-wordpress-coding-standards

Author: swissspidy

.github/workflows/issue-triage.yml

@@ -4,7 +4,7 @@ name: Issue and PR Triage
 'on':
   issues:
     types: [opened]
-  pull_request:
+  pull_request_target:
     types: [opened]
   workflow_dispatch:
     inputs:
@@ -20,7 +20,7 @@ jobs:
       issue_number: >-
         ${{
           (github.event_name == 'workflow_dispatch' && inputs.issue_number) ||
-          (github.event_name == 'pull_request' && github.event.pull_request.number) ||
+          (github.event_name == 'pull_request_target' && github.event.pull_request.number) ||
           (github.event_name == 'issues' && github.event.issue.number) ||
           ''
         }}

.github/workflows/welcome-new-contributors.yml

@@ -0,0 +1,12 @@
+name: Welcome New Contributors
+
+on:
+  pull_request_target:
+    types: [opened]
+    branches:
+      - main
+      - master
+
+jobs:
+  welcome:
+    uses: wp-cli/.github/.github/workflows/reusable-welcome-new-contributors.yml@main

features/scaffold-package-readme.feature

@@ -352,3 +352,37 @@ Feature: Scaffold a README.md file for an existing package
       """
       This package is included with WP-CLI itself
       """
+
+  Scenario: README includes command aliases
+    Given an empty directory
+    And a foo/composer.json file:
+      """
+      {
+          "name": "wp-cli/alias-test",
+          "description": "Test package for command aliases",
+          "license": "MIT",
+          "authors": [],
+          "minimum-stability": "dev",
+          "autoload": {
+              "files": [ "command.php" ]
+          },
+          "require": {
+              "wp-cli/wp-cli": "^2.12"
+          },
+          "require-dev": {
+              "wp-cli/wp-cli-tests": "^5.0.0"
+          },
+          "extra": {
+              "commands": [
+                "scaffold post-type"
+              ]
+          }
+      }
+      """
+
+    When I run `wp scaffold package-readme foo`
+    Then the foo/README.md file should exist
+    And the foo/README.md file should contain:
+      """
+      **Alias:** `cpt`
+      """

src/ScaffoldPackageCommand.php

@@ -350,12 +350,19 @@ public function package_readme( $args, $assoc_args ) {
 				// definition lists
 				$longdesc = preg_replace_callback( '/([^\n]+)\n: (.+?)(\n\n|$)/s', [ __CLASS__, 'rewrap_param_desc' ], $longdesc );
 
-				$readme_args['commands'][] = [
+				$command_data = [
 					'name'      => "wp {$command}",
 					'shortdesc' => isset( $parent_command['description'] ) ? $parent_command['description'] : '',
 					'synopsis'  => "wp {$command}" . ( empty( $parent_command['subcommands'] ) ? ( isset( $parent_command['synopsis'] ) ? " {$parent_command['synopsis']}" : '' ) : '' ),
 					'longdesc'  => $longdesc,
 				];
+
+				// Add alias if present.
+				if ( ! empty( $parent_command['alias'] ) ) {
+					$command_data['alias'] = $parent_command['alias'];
+				}
+
+				$readme_args['commands'][] = $command_data;
 			}
 			$readme_args['has_commands']          = true;
 			$readme_args['has_multiple_commands'] = count( $readme_args['commands'] ) > 1;

templates/readme-using.mustache

@@ -15,6 +15,10 @@ This package implements the following commands:
 {{synopsis}}
 ~~~
 
+{{#alias}}
+**Alias:** `{{alias}}`
+
+{{/alias}}
 {{longdesc}}
 
 {{/commands}}