[5.2] Add script to update titles on github

build/github_update_title.php

@@ -0,0 +1,183 @@
+<?php
+
+/**
+ * This script rebases Joomla Github Pull Requests to the target branch
+ *
+ * @package            Joomla.Build
+ * @copyright          (C) 2022 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license            GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+// Set defaults
+$scriptRoot       = __DIR__;
+$prNumber         = false;
+$php              = 'php';
+$git              = 'git';
+$gh               = 'gh';
+$checkPath        = false;
+$ghRepo           = 'joomla/joomla-cms';
+$baseBranches     = '4.1-dev';
+$label            = '';
+$additionalReason = '';
+$tryRun           = false;
+
+$script = array_shift($argv);
+
+if (empty($argv)) {
+    echo <<<TEXT
+        Joomla! Github Rebase script
+        ============================
+        Usage:
+            php {$script} --base=4.1-dev[,...] --target=4.2-dev [--pr=<number>]
+
+        Description:
+            Rebase all open pull requests on github to the target branch.
+
+            --try-run:
+              Just list the PRs which would be rebased.
+
+            --base:
+              The base branch of the pull request. Multiple branches can be separated by comma.
+
+            --label:
+              The tag of the pull request must have to be rebased.
+
+            --pr:
+              Rebase only the given PR.
+
+        TEXT;
+    die(1);
+}
+
+foreach ($argv as $arg) {
+    if (substr($arg, 0, 2) === '--') {
+        $argi = explode('=', $arg, 2);
+        switch ($argi[0]) {
+            case '--try-run':
+                $tryRun = true;
+                break;
+            case '--base':
+                $baseBranches = $argi[1];
+                break;
+            case '--pr':
+                    $prNumber = $argi[1];
+                break;
+            case '--label':
+                    $label = $argi[1];
+                break;
+            case '--reason':
+                    $additionalReason = $argi[1];
+                break;
+            default:
+                die('Unknown option: ' . $argi[0]);
+        }
+    } else {
+        $checkPath = $arg;
+        break;
+    }
+}
+
+$cmd        = $git . ' -C "' . $scriptRoot . '" rev-parse --show-toplevel';
+$output     = [];
+$repoScript = '';
+exec($cmd, $output, $result);
+if ($result !== 0) {
+    $repoScript = $output[0];
+    die($script . ' must be located inside of the git repository');
+}
+
+echo "Validate gh client...\n";
+$cmd    = $gh;
+$output = [];
+exec($cmd, $output, $result);
+if ($result !== 0) {
+    die('Github cli client not found. Please install the client first (https://cli.github.com)');
+}
+
+echo "Validate gh authentication...\n";
+$cmd = $gh . ' auth status';
+passthru($cmd, $result);
+if ($result !== 0) {
+    die('Please login with the github cli client first. (gh auth login)');
+}
+
+$fieldList = [
+    "number",
+    "author",
+    "baseRefName",
+    "headRefName",
+    "headRepository",
+    "headRepositoryOwner",
+    "isCrossRepository",
+    "maintainerCanModify",
+    "mergeStateStatus",
+    "mergeable",
+    "state",
+    "title",
+    "url",
+    "labels",
+];
+
+$branches = 'base:' . implode(' base:', explode(',', $baseBranches));
+
+if (!empty($label)) {
+    $branches .= ' label:' . $label;
+}
+
+if (!empty($prNumber)) {
+    echo "Retrieving Pull Request " . $prNumber . "...\n";
+    $cmd = $gh . ' pr view ' . $prNumber . ' --json ' . implode(',', $fieldList);
+} else {
+    echo "Retrieving Pull Request list...\n";
+    $cmd = $gh . ' pr list --limit 1000 --json ' . implode(',', $fieldList) . ' --search "is:pr is:open ' . $branches . '"';
+}
+
+$output = [];
+exec($cmd, $output, $result);
+if ($result !== 0) {
+    var_dump([$cmd, $output, $result]);
+    die('Unable to retrieve PR list.');
+}
+
+$json = $output[0];
+
+if (!empty($prNumber)) {
+    $json = '[' . $json . ']';
+}
+
+$list = json_decode($json, true);
+
+echo "\nFound " . count($list) . " pull request(s).\n";
+
+foreach ($list as $pr) {
+    echo "Change Title for PR #" . $pr['number'] . "\n";
+
+    $branch = substr($pr['baseRefName'], 0, strpos($pr['baseRefName'], '-'));
+
+    $title = $pr['title'];
+
+    if (str_contains($title, ']') && strpos($title, ']') < 10) {
+        $title = substr($title, strpos($title, ']') + 1);
+    }
+
+    $newTitle = '[' . $branch . '] ' . trim($title);
+
+    if ($newTitle === $pr['title']) {
+        continue;
+    }
+
+    echo 'OLD: ' . trim($pr['title']) ."\n";
+    echo 'NEW: ' . $newTitle ."\n";
+
+    $cmd    = $gh . ' pr edit ' . $pr['url'] . ' --title "' . str_replace('"', '\"', $newTitle) . '"';
+    $output = [];
+    if (!$tryRun) {
+        exec($cmd, $output, $result);
+        if ($result !== 0) {
+            var_dump([$cmd, $output, $result]);
+            die('Unable to set target branch for pr #' . $pr['number']);
+        }
+    } else {
+        echo "TRY RUN: " . $cmd . "\n";
+    }
+}