Changeset 9539

Timestamp:

02/26/2020 06:13:24 AM (5 years ago)

Author:

dd32

Message:

Trac: Github PRs: Filter out HTML comments and standard code-review-only boilerplate from PR descriptions before posting them to Trac.

Props isabel_brison for the suggestion.
Fixes #5057.

Location:

sites/trunk/api.wordpress.org/public_html/dotorg/trac/pr

Files:

• functions.php (modified) (1 diff)
• webhook.php (modified) (2 diffs)

sites/trunk/api.wordpress.org/public_html/dotorg/trac/pr/functions.php

@@ -153 +153 @@
     return new Trac( GH_PRBOT_USER, GH_PRBOT_PASS, $trac_uri );
 }
+
+/**
+ * Formats a PR description for usage on Trac.
+ * 
+ * This strips out HTML comments and standard boilerplate text.
+ * 
+ * @param object $pr_data PR Data.
+ * @return string Stripped down PR Description
+ */
+function format_pr_desc_for_trac_comment( $pr_data ) {
+    $desc = trim( $pr_data->body );
+
+    // Remove HTML comments
+    $desc = preg_replace( '#<!--.+?-->#', '', $desc );
+
+    // Remove the final line if it matches the specific boilerplate format.
+    $desc = preg_replace( "#---\r?\n\*\*.+\*\*$#", '', $desc );
+
+    return trim( $desc );
+}

sites/trunk/api.wordpress.org/public_html/dotorg/trac/pr/webhook.php

@@ -80 +80 @@
             $trac = get_trac_instance( $pr_data->trac_ticket[0] );
 
+            $pr_description = format_pr_desc_for_trac_comment( $pr_data );
+
             $trac->update(
                 $pr_data->trac_ticket[1],
@@ -85 +87 @@
                     "on [https://github.com/{$pr_repo}/ {$pr_repo}] " .
                     "by [{$pr_data->user->url} {$pr_data->user->name}].''" .
-                    ( trim( $pr_data->body ) ? "\n{$pr_data->body}" : '' ),
+                    ( $pr_description ? "\n{$pr_description}" : '' ),
                 [],  // Attributes changed
                 true // Notify