Handle push events in git/git by triggering the sync-ref workflow

We added the `sync-ref` GitHub workflow in gitgitgadget/gitgitgadget-workflows#1 specifically to let it be triggered by `push` webhook events delivered to GitGitGadget's GitHub App. And this is the commit that teaches the GitHub App that trick. Signed-off-by: Johannes Schindelin <[email protected]>
gitgitgadget · Aug 31, 2023 · 8747931 · 8747931
1 parent da326af
commit 8747931
Show file tree

Hide file tree

Showing 2 changed files with 71 additions and 0 deletions.
diff --git a/GitGitGadget/index.js b/GitGitGadget/index.js
@@ -12,6 +12,8 @@ const { validateGitHubWebHook } = require('./validate-github-webhook');
 
 const { triggerAzurePipeline } = require('./trigger-azure-pipeline');
 
+const { triggerWorkflowDispatch } = require('./trigger-workflow-dispatch')
+
 module.exports = async (context, req) => {
     try {
         validateGitHubWebHook(context);
@@ -55,6 +57,22 @@ module.exports = async (context, req) => {
             context.res = {
                 body: `Ignored event type: ${eventType}`,
             };
+        } else if (eventType === 'push') {
+            if (req.body.repository.full_name !== 'git/git') {
+                context.res = { body: `Ignoring pushes to ${req.body.repository.full_name}` }
+            } else {
+                const run = await triggerWorkflowDispatch(
+                    context,
+                    undefined,
+                    'gitgitgadget',
+                    'gitgitgadget-workflows',
+                    'sync-ref.yml',
+                    'main', {
+                        ref: req.body.ref
+                    }
+                )
+                context.res = { body: `push(${req.body.ref}): triggered ${run.html_url}` }
+            }
         } else if (eventType === 'issue_comment') {
             const triggerToken = process.env['GITGITGADGET_TRIGGER_TOKEN'];
             if (!triggerToken) {

diff --git a/__tests__/index.test.js b/__tests__/index.test.js
@@ -1,3 +1,14 @@
+const mockTriggerWorkflowDispatch = jest.fn(async (_context, _token, owner, repo, workflow_id, ref, inputs) => {
+    expect(`${owner}/${repo}`).toEqual('gitgitgadget/gitgitgadget-workflows')
+    expect(workflow_id).toEqual('sync-ref.yml')
+    expect(ref).toEqual('main')
+    expect(inputs).toEqual({ ref: 'refs/heads/next' })
+    return { html_url: '<the URL to the workflow run>'}
+})
+jest.mock('../GitGitGadget/trigger-workflow-dispatch', () => ({
+    triggerWorkflowDispatch: mockTriggerWorkflowDispatch
+}))
+
 const index = require('../GitGitGadget/index')
 const crypto = require('crypto')
 const stream = require('stream')
@@ -157,4 +168,46 @@ testIssueComment('/verify-repository', 'nope', (context) => {
     })
     expect(mockRequest.write).not.toHaveBeenCalled()
     expect(mockRequest.end).not.toHaveBeenCalled()
+})
+
+const testWebhookPayload = (testLabel, gitHubEvent, payload, fn) => {
+    const context = makeContext(payload, {
+        'x-github-event': gitHubEvent
+    })
+
+    test(testLabel, async () => {
+        try {
+            expect(await index(context, context.req)).toBeUndefined()
+            await fn(context)
+            expect(context.done).toHaveBeenCalledTimes(1)
+        } catch (e) {
+            context.log.mock.calls.forEach(e => console.log(e[0]))
+            throw e;
+        }
+    })
+}
+
+testWebhookPayload('react to `next` being pushed to git/git', 'push', {
+    ref: 'refs/heads/next',
+    repository: {
+        full_name: 'git/git',
+        owner: {
+            login: 'git'
+        }
+    }
+}, (context) => {
+    expect(context.res).toEqual({
+        body: 'push(refs/heads/next): triggered <the URL to the workflow run>'
+    })
+    expect(mockTriggerWorkflowDispatch).toHaveBeenCalledTimes(1)
+    expect(mockTriggerWorkflowDispatch.mock.calls[0]).toEqual([
+        context,
+        undefined,
+        'gitgitgadget',
+        'gitgitgadget-workflows',
+        'sync-ref.yml',
+        'main', {
+            ref: 'refs/heads/next'
+        }
+    ])
 })