feat: wrangler logs

.changeset/cold-wombats-swim.md

@@ -0,0 +1,5 @@
+---
+"github-actions-cloudflare-pages": minor
+---
+
+feat: wrangler output shown in summary and PR comment

README.md

@@ -155,6 +155,9 @@ environment:
 alias:
   description: 'Cloudflare Pages deployed alias. Fallsback to deployed url if deployed alias is null'
   value: ${{ steps.action.outputs.alias }}
+wrangler:
+  description: 'Wrangler cli output'
+  values: ${{ steps.action.outputs.wrangler }}
 ```
 
 ## Comment Example

__mocks__/@unlike/github-actions-core/index.ts

@@ -14,9 +14,11 @@ export const notice = vi.fn()
 export const debug = vi.fn()
 export const isDebug = vi.fn().mockReturnValue(false)
 export const setFailed = vi.fn()
+export const info = vi.fn()
 
 export const summary = core.summary
 summary.addTable = vi.fn().mockReturnValue(summary)
 summary.addHeading = vi.fn().mockReturnValue(summary)
 summary.addBreak = vi.fn().mockReturnValue(summary)
+summary.addRaw = vi.fn().mockReturnValue(summary)
 summary.write = vi.fn()

__tests__/cloudflare/deployment/__snapshots__/create.test.ts.snap

@@ -1,6 +1,6 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`createCloudflareDeployment > api calls > handles success 1`] = `
+exports[`createCloudflareDeployment > api calls > handles success 2`] = `
 {
   "aliases": [
     "https://unknown-branch.cloudflare-pages-action-a5z.pages.dev",

__tests__/cloudflare/deployment/create.test.ts

@@ -1,4 +1,4 @@
-import {setOutput, summary} from '@unlike/github-actions-core'
+import {info, setOutput, summary} from '@unlike/github-actions-core'
 import {afterEach, beforeEach, describe, expect, test, vi} from 'vitest'
 
 import type {MockApi} from '@/tests/helpers/api.js'
@@ -19,6 +19,7 @@ vi.mock('@unlike/github-actions-core')
 describe('createCloudflareDeployment', () => {
   describe('api calls', () => {
     let mockApi: MockApi
+
     beforeEach(() => {
       mockApi = setMockApi()
     })
@@ -28,8 +29,8 @@ describe('createCloudflareDeployment', () => {
     })
 
     test('handles thrown error from wrangler deploy', async () => {
-      expect.assertions(9)
-      vi.mocked(execAsync).mockRejectedValue({stderr: 'Oh no!'})
+      expect.assertions(10)
+      vi.mocked(execAsync).mockRejectedValue({stderr: 'Oh no!', stdout: ''})
 
       // Expect Cloudflare Api Token and Account Id to be undefined.
       expect(process.env[CLOUDFLARE_API_TOKEN]).toBeUndefined()
@@ -51,6 +52,7 @@ describe('createCloudflareDeployment', () => {
       )
 
       expect(execAsync).toHaveBeenCalledTimes(1)
+      expect(info).not.toHaveBeenCalled()
       expect(process.env[CLOUDFLARE_API_TOKEN]).toBe(
         'mock-cloudflare-api-token'
       )
@@ -63,7 +65,7 @@ describe('createCloudflareDeployment', () => {
     })
 
     test('handles thrown error from getDeployments', async () => {
-      expect.assertions(4)
+      expect.assertions(5)
       vi.mocked(execAsync).mockResolvedValue({
         stdout: 'success',
         stderr: ''
@@ -81,12 +83,13 @@ describe('createCloudflareDeployment', () => {
         `[ParseError: A request to the Cloudflare API (https://api.cloudflare.com/client/v4/accounts/mock-cloudflare-account-id/pages/projects/mock-cloudflare-project-name/deployments) failed.]`
       )
       expect(execAsync).toHaveBeenCalledTimes(1)
+      expect(info).toHaveBeenLastCalledWith('success')
       expect(setOutput).not.toHaveBeenCalled()
       expect(summary.addTable).not.toHaveBeenCalled()
     })
 
     test('handles success', async () => {
-      expect.assertions(11)
+      expect.assertions(14)
       vi.mocked(execAsync).mockResolvedValue({
         stdout: 'success',
         stderr: ''
@@ -106,14 +109,16 @@ describe('createCloudflareDeployment', () => {
         200
       )
 
-      const deployment = await createCloudflareDeployment()
+      const {deployment, wranglerOutput} = await createCloudflareDeployment()
 
+      expect(wranglerOutput).toMatchInlineSnapshot(`"success"`)
       expect(deployment).toMatchSnapshot()
       expect(deployment.id).toMatchInlineSnapshot(
         '"206e215c-33b3-4ce4-adf4-7fc6c9b65483"'
       )
+      expect(info).toHaveBeenLastCalledWith('success')
 
-      expect(setOutput).toHaveBeenCalledTimes(4)
+      expect(setOutput).toHaveBeenCalledTimes(5)
       expect(setOutput).toHaveBeenNthCalledWith(
         1,
         'id',
@@ -130,6 +135,7 @@ describe('createCloudflareDeployment', () => {
         'alias',
         'https://unknown-branch.cloudflare-pages-action-a5z.pages.dev'
       )
+      expect(setOutput).toHaveBeenNthCalledWith(5, 'wrangler', 'success')
 
       expect(summary.addHeading).toHaveBeenCalledWith(
         `Cloudflare Pages Deployment`
@@ -166,7 +172,8 @@ describe('createCloudflareDeployment', () => {
         [
           'Branch Preview URL:',
           `<a href='https://unknown-branch.cloudflare-pages-action-a5z.pages.dev'>https://unknown-branch.cloudflare-pages-action-a5z.pages.dev</a>`
-        ]
+        ],
+        ['Wrangler Output:', `success`]
       ])
     })
   })

__tests__/github/comment.test.ts

@@ -30,7 +30,7 @@ describe('addComment', () => {
         query: MutationAddComment,
         variables: {
           subjectId: 'MDExOlB1bGxSZXF1ZXN0Mjc5MTQ3NDM3',
-          body: '## Cloudflare Pages Deployment\n **Environment:** production \n **Project:** cloudflare-pages-action \n **Built with commit:** mock-github-sha\n **Preview URL:** https://206e215c.cloudflare-pages-action-a5z.pages.dev \n **Branch Preview URL:** https://unknown-branch.cloudflare-pages-action-a5z.pages.dev'
+          body: '## Cloudflare Pages Deployment\n**Environment:** production\n**Project:** cloudflare-pages-action\n**Built with commit:** mock-github-sha\n**Preview URL:** https://206e215c.cloudflare-pages-action-a5z.pages.dev\n**Branch Preview URL:** https://unknown-branch.cloudflare-pages-action-a5z.pages.dev\n\n### Wrangler Output\nsuccess'
         }
       },
       {
@@ -46,7 +46,7 @@ describe('addComment', () => {
       }
     )
 
-    const comment = await addComment(mockData)
+    const comment = await addComment(mockData, 'success')
     expect(comment).toBe('1')
   })
 
@@ -64,7 +64,7 @@ describe('addComment', () => {
         payload: {}
       } as Readonly<WorkflowEventExtract<typeof eventName>>)
 
-      await expect(addComment(mockData)).resolves.toBeUndefined()
+      await expect(addComment(mockData, 'success')).resolves.toBeUndefined()
     }
   )
 })

__tests__/main.test.ts

@@ -6,6 +6,7 @@ import type {MockApi} from '@/tests/helpers/api.js'
 import RESPONSE_DEPLOYMENTS from '@/responses/api.cloudflare.com/pages/deployments/deployments.response.json'
 import RESPONSE_PROJECT from '@/responses/api.cloudflare.com/pages/projects/project.response.json'
 import {run} from '@/src/main.js'
+import {execAsync} from '@/src/utils.js'
 import {
   MOCK_API_PATH,
   MOCK_API_PATH_DEPLOYMENTS,
@@ -34,6 +35,10 @@ describe('main', () => {
   describe('run', () => {
     describe('handles resolve', () => {
       beforeEach(() => {
+        vi.mocked(execAsync).mockResolvedValue({
+          stdout: 'success',
+          stderr: ''
+        })
         mockApi.interceptCloudflare(MOCK_API_PATH, RESPONSE_PROJECT, 200)
         mockApi.interceptCloudflare(
           MOCK_API_PATH_DEPLOYMENTS,
@@ -49,7 +54,7 @@ describe('main', () => {
 
         expect(main).toBeUndefined()
 
-        expect(spySetOutput).toHaveBeenCalledTimes(4)
+        expect(spySetOutput).toHaveBeenCalledTimes(5)
         // TODO @andykenward add checks for setOutput
         mockApi.mockAgent.assertNoPendingInterceptors()
       })

action.yml

@@ -34,6 +34,8 @@ outputs:
     description: 'Cloudflare Pages deployed environment "production" or "preview"'
   alias:
     description: 'Cloudflare Pages deployed alias. Fallsback to deployed url if deployed alias is null'
+  wrangler:
+    description: 'Wrangler cli output'
 
 runs:
   using: node20

src/cloudflare/deployment/create.ts

@@ -1,6 +1,8 @@
 import {strict} from 'node:assert'
 
-import {setOutput, summary} from '@unlike/github-actions-core'
+import {info, setOutput, summary} from '@unlike/github-actions-core'
+
+import type {PagesDeployment} from '../types.js'
 
 import {useContext} from '../../github/context.js'
 import {useInputs} from '../../inputs.js'
@@ -12,7 +14,10 @@ export const CLOUDFLARE_API_TOKEN = 'CLOUDFLARE_API_TOKEN'
 export const CLOUDFLARE_ACCOUNT_ID = 'CLOUDFLARE_ACCOUNT_ID'
 const ERROR_KEY = `Create Deployment:`
 
-export const createCloudflareDeployment = async () => {
+export const createCloudflareDeployment = async (): Promise<{
+  deployment: PagesDeployment
+  wranglerOutput: string
+}> => {
   const {
     cloudflareAccountId,
     cloudflareProjectName,
@@ -41,12 +46,16 @@ export const createCloudflareDeployment = async () => {
     /**
      * Tried to use wrangler.unstable_pages.deploy. But wrangler is 8mb+ and the bundler is unable to tree shake it.
      */
-    await execAsync(
+    const {stdout} = await execAsync(
       `npx wrangler@${WRANGLER_VERSION} pages deploy ${directory} --project-name=${cloudflareProjectName} --branch=${branch} --commit-dirty=true --commit-hash=${commitHash}`,
       {
         env: process.env
       }
     )
+    /**
+     * Log out wrangler output.
+     */
+    info(stdout)
     /**
      * Get the latest deployment by commitHash and poll until required status.
      */
@@ -58,10 +67,11 @@ export const createCloudflareDeployment = async () => {
 
     const alias: string = getCloudflareDeploymentAlias(deployment)
     setOutput('alias', alias)
+    setOutput('wrangler', stdout)
 
-    await summary.addHeading('Cloudflare Pages Deployment').write()
-    await summary.addBreak().write()
     await summary
+      .addHeading('Cloudflare Pages Deployment')
+      .addBreak()
       .addTable([
         [
           {
@@ -88,11 +98,12 @@ export const createCloudflareDeployment = async () => {
         ],
         ['Status:', `<strong>${status.toUpperCase() || `UNKNOWN`}</strong>`],
         ['Preview URL:', `<a href='${deployment.url}'>${deployment.url}</a>`],
-        ['Branch Preview URL:', `<a href='${alias}'>${alias}</a>`]
+        ['Branch Preview URL:', `<a href='${alias}'>${alias}</a>`],
+        ['Wrangler Output:', `${stdout}`]
       ])
       .write()
 
-    return deployment
+    return {deployment, wranglerOutput: stdout}
   } catch (error) {
     if (error instanceof Error) {
       throw error

src/github/comment.ts

@@ -20,7 +20,8 @@ export const MutationAddComment = graphql(/* GraphQL */ `
 `)
 
 export const addComment = async (
-  deployment: PagesDeployment
+  deployment: PagesDeployment,
+  output: string
 ): Promise<string | undefined> => {
   const {eventName, payload} = useContextEvent()
 
@@ -30,13 +31,7 @@ export const addComment = async (
 
     const {sha} = useContext()
 
-    const rawBody = `## Cloudflare Pages Deployment\n **Environment:** ${
-      deployment.environment
-    } \n **Project:** ${
-      deployment.project_name
-    } \n **Built with commit:** ${sha}\n **Preview URL:** ${
-      deployment.url
-    } \n **Branch Preview URL:** ${getCloudflareDeploymentAlias(deployment)}`
+    const rawBody = `## Cloudflare Pages Deployment\n**Environment:** ${deployment.environment}\n**Project:** ${deployment.project_name}\n**Built with commit:** ${sha}\n**Preview URL:** ${deployment.url}\n**Branch Preview URL:** ${getCloudflareDeploymentAlias(deployment)}\n\n### Wrangler Output\n${output}`
 
     const comment = await request({
       query: MutationAddComment,

src/main.ts

@@ -44,7 +44,8 @@ export async function run() {
     }
   }
 
-  const cloudflareDeployment = await createCloudflareDeployment()
-  const commentId = await addComment(cloudflareDeployment)
+  const {deployment: cloudflareDeployment, wranglerOutput} =
+    await createCloudflareDeployment()
+  const commentId = await addComment(cloudflareDeployment, wranglerOutput)
   await createGitHubDeployment(cloudflareDeployment, commentId)
 }