Merge pull request webpack#7307 from webpack/bot/document-on-merge

sokra · web-flow · commit 8d36df13aa35 · 2018-05-15T14:21:07.000+02:00
Improve pull request template and add automatic issue to docs
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,4 +1,9 @@
 <!-- Thanks for submitting a pull request! Please provide enough information so that others can review your pull request. -->
+<!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? -->
+<!-- Try to link to an open issue for more information. -->
+
+
+<!-- In addition to that please answer these questions: -->
 
 **What kind of change does this PR introduce?**
 
@@ -8,17 +13,11 @@
 
 <!-- Note that we won't merge your changes if you don't add tests -->
 
-**If relevant, link to documentation update:**
-
-<!-- Link PR from webpack/webpack.js.org here, or N/A -->
-
-**Summary**
-
-<!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? -->
-<!-- Try to link to an open issue for more information. -->
-
 **Does this PR introduce a breaking change?**
 
 <!-- If this PR introduces a breaking change, please describe the impact and a migration path for existing applications. -->
 
-**Other information**
+**What needs to be documented once your changes are merged?**
+
+<!-- List all the information that needs to be added to the documentation after merge -->
+<!-- When your changes are merged you will be asked to contribute this to the documentation -->
diff --git a/open-bot.yaml b/open-bot.yaml
@@ -517,6 +517,53 @@ rules:
         If you think this is still a valid issue, please file a new issue with additional information.
 
 
+# Add action actions box to each pull request
+- filters:
+    pull_request: true
+    open: true
+    not:
+      comment:
+        matching: admin-actions
+        author: webpack-bot
+  actions:
+    comment:
+      identifier: admin-actions
+      message: |-
+        *For maintainers only:*
+
+        * [x] <!-- document --> This need to be documented (issue in webpack/webpack.js.org will be filed when merged)
+
+
+# When a pull request need to be documented, create an issue in webpack/webpack.js.org when merged
+- filters:
+    pull_request:
+      merged: true
+    comment:
+      author: webpack-bot
+      matching: "\\* \\[x\\] <!-- document -->"
+    not:
+      comment_1:
+        author: webpack-bot
+        matching: admin-action-document-executed
+  actions:
+    new_issue:
+      target: webpack/webpack.js.org
+      title: "Document webpack change: {{{pull_request.title}}}"
+      body: |-
+        <!-- documentation request from webpack/webpack -->
+
+        *A pull request by @{{pull_request.user.login}} was merged and maintainers requested a documentation change.*
+
+        See pull request: {{{pull_request.html_url}}}
+
+        ---
+
+        {{{pull_request.body}}}
+    comment:
+      identifier: admin-action-document-executed
+      message: |-
+        I've created an issue to document this in webpack/webpack.js.org.
+
 
 
 
