feat: new event actions and examples from example payload files provided by @rachmari

lib/check-or-update-webhooks.js

@@ -8,6 +8,7 @@ const getHtml = require('./get-html')
 const applyWorkarounds = require('./workarounds')
 const getSections = require('./get-sections')
 const toWebhook = require('./section-to-webhook')
+const getActionsAndExamplesFromPayloads = require('./get-actions-and-examples-from-payloads')
 
 async function checkOrUpdateWebhooks ({ cached, checkOnly }) {
   const state = {
@@ -17,7 +18,24 @@ async function checkOrUpdateWebhooks ({ cached, checkOnly }) {
 
   const html = await getHtml({ cached })
   const sections = await getSections(state, html)
-  const webhooks = sections.map(toWebhook.bind(null, state)).filter(Boolean)
+  const webhooksFromScrapingDocs = sections.map(toWebhook.bind(null, state)).filter(Boolean)
+  const webhooksFromPayloadExamplesByName = getActionsAndExamplesFromPayloads()
+
+  const webhooks = webhooksFromScrapingDocs.map((webhook) => {
+    const name = webhook.name
+    const webhookFromPayloadExamples = webhooksFromPayloadExamplesByName[name]
+
+    if (!webhookFromPayloadExamples) {
+      console.warn(`No payload examples for ${name}`)
+      return webhook
+    }
+
+    return {
+      name,
+      actions: [...new Set(webhook.actions.concat(webhookFromPayloadExamples.actions))],
+      examples: webhook.examples.concat(webhookFromPayloadExamples.examples)
+    }
+  })
 
   applyWorkarounds(webhooks)
 

lib/get-actions-and-examples-from-payloads.js

@@ -0,0 +1,26 @@
+module.exports = getActionsAndExamplesFromPayloads
+
+const { readdirSync } = require('fs')
+
+function getActionsAndExamplesFromPayloads () {
+  const eventsByName = {}
+  for (const path of readdirSync('payload-examples/api.github.com')) {
+    const [name] = path.split('.')
+
+    const payload = require(`../payload-examples/api.github.com/${path}`)
+
+    if (!eventsByName[name]) {
+      eventsByName[name] = {
+        actions: [],
+        examples: []
+      }
+    }
+
+    if (payload.action) {
+      eventsByName[name].actions.push(payload.action)
+    }
+    eventsByName[name].examples.push(payload)
+  }
+
+  return eventsByName
+}

lib/workarounds.js

@@ -8,34 +8,20 @@ function workarounds (webhooks) {
 
   // https://github.com/octokit/webhooks/issues/4
   webhooks.forEach(webhook => {
-    if (webhook.name === 'member') {
-      if (webhook.actions.length) {
-        throw new Error('Remove workaround to get "member" actions')
-      }
-
-      webhook.actions = [
-        'added',
-        'deleted',
-        'edited'
-      ]
-    }
-
-    if (webhook.name === 'commit_comment') {
-      if (webhook.actions.length) {
-        throw new Error('Remove workaround to get "commit_comment" actions')
+    if (webhook.name === 'pull_request') {
+      if (webhook.actions.includes('synchronize')) {
+        throw new Error('Remove workaround that adds "synchronize" action to "pull_request" event')
       }
 
-      webhook.actions = [
-        'created'
-      ]
+      webhook.actions = webhook.actions.concat('synchronize').sort()
     }
 
-    if (webhook.name === 'pull_request') {
-      if (webhook.actions.includes('synchronize')) {
-        throw new Error('Remove workaround add "synchronize" event to "pull_request"')
+    if (webhook.name === 'member') {
+      if (webhook.actions.includes('removed')) {
+        throw new Error('Remove workaround that adds "removed" action to "member" event')
       }
 
-      webhook.actions.push('synchronize')
+      webhook.actions = webhook.actions.concat('removed').sort()
     }
   })
 }