👷 better PR comment. Less duplication of domains in Summary

mountainash · May 7, 2024 · 2c07823 · 2c07823
1 parent 230baa0
commit 2c07823
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 53 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,13 +2,16 @@
 
 ## [2.3.2] - 2024-05-07
 
-- truncate long ALIAS_DOMAINS values
+- Unique domain added to PR comment
+- Markdown table PR comment formatting
+- less domain duplication in the Workflow Summary
+- Truncate long ALIAS_DOMAINS values
 - 📦 [email protected]
 
 ## [2.3.1] - 2024-04-26
 
-- better logging of ALIAS_DOMAINS output
-- skipping falsey ALIAS_DOMAINS values
+- Better logging of ALIAS_DOMAINS output
+- Skipping falsey ALIAS_DOMAINS values
 - 📦 [email protected]
 
 ## [2.3.0] - 2024-04-12

diff --git a/dist/index.js b/dist/index.js
@@ -32680,40 +32680,27 @@ const run = async () => {
 
 			if (CREATE_COMMENT) {
 				core.info('Creating new comment on PR 💬')
-				const body = `
-					This pull request has been deployed to Vercel ▲.
-
-					<table>
-						<tr>
-							<th>Latest Commit</th>
-							<td><code>${ SHA.substring(0, 7) }</code></td>
-						</tr>
-						<tr>
-							<th>👀 Preview</th>
-							<td><a href='${ previewUrl }'>${ previewUrl }</a></td>
-						</tr>
-						<tr>
-							<th>🔍 Inspect</th>
-							<td><a href='${ deployment.inspectorUrl }'>${ deployment.inspectorUrl }</a></td>
-						</tr>
-					</table>
-
-					[View GitHub Actions Workflow Logs](${ LOG_URL })
+				const body = `This pull request (commit \`${ SHA.substring(0, 7) }\`) has been deployed to Vercel ▲ - [View GitHub Actions Workflow Logs](${ LOG_URL })
+
+| Name | Link |
+| :--- | :--- |
+| 👀 Preview	| <${ previewUrl }> |
+| 🌐 Unique 	| <${ deploymentUniqueURL }> |
+| 🔍 Inspect	| <${ deployment.inspectorUrl }> |
 				`
 
 				const comment = await github.createComment(body)
 				core.info(`Comment created: ${ comment.html_url }`)
 			}
 
 			if (PR_LABELS.length) {
-				core.info('Adding label(s) to PR 🏷️')
 				const labels = await github.addLabel()
 
-				core.info(`Label(s) "${ labels.map((label) => label.name).join(', ') }" added`)
+				core.info(`Label(s) "${ labels.map((label) => label.name).join(', ') }" added to PR 🏷️`)
 			}
 		}
 
-		const deploymentUniqueURL = deploymentUrls[deploymentUrls.length - 1]
+		const deploymentUniqueURL = deploymentUrls.at(-1)
 
 		core.setOutput('PREVIEW_URL', previewUrl)
 		core.setOutput('DEPLOYMENT_URLS', deploymentUrls)
@@ -32726,10 +32713,10 @@ const run = async () => {
 		const summaryMD = `## Deploy to Vercel ▲
 | Name | Link |
 | :--- | :--- |
-| 🔍 Inspect	| <${ deployment.inspectorUrl }> |
 | 👀 Preview	| <${ previewUrl }> |
 | 🌐 Unique 	| <${ deploymentUniqueURL }> |
-| 🌐 Others 	| ${ deploymentUrls.join('<br>') } |
+| 🌐 Others 	| ${ deploymentUrls.splice(2, -1).join('<br>') } |
+| 🔍 Inspect	| <${ deployment.inspectorUrl }> |
 		`
 
 		await core.summary.addRaw(summaryMD).write()
@@ -32738,7 +32725,7 @@ const run = async () => {
 		core.exportVariable('VERCEL_PREVIEW_URL', previewUrl)
 		core.exportVariable('VERCEL_DEPLOYMENT_UNIQUE_URL', deploymentUniqueURL)
 
-		core.info('Done')
+		core.info('Done ✅')
 	} catch (err) {
 		await github.updateDeployment('failure')
 		core.error(`Catch Error: ${ err }`)

diff --git a/src/index.js b/src/index.js
@@ -145,40 +145,27 @@ const run = async () => {
 
 			if (CREATE_COMMENT) {
 				core.info('Creating new comment on PR 💬')
-				const body = `
-					This pull request has been deployed to Vercel ▲.
-
-					<table>
-						<tr>
-							<th>Latest Commit</th>
-							<td><code>${ SHA.substring(0, 7) }</code></td>
-						</tr>
-						<tr>
-							<th>👀 Preview</th>
-							<td><a href='${ previewUrl }'>${ previewUrl }</a></td>
-						</tr>
-						<tr>
-							<th>🔍 Inspect</th>
-							<td><a href='${ deployment.inspectorUrl }'>${ deployment.inspectorUrl }</a></td>
-						</tr>
-					</table>
-
-					[View GitHub Actions Workflow Logs](${ LOG_URL })
+				const body = `This pull request (commit \`${ SHA.substring(0, 7) }\`) has been deployed to Vercel ▲ - [View GitHub Actions Workflow Logs](${ LOG_URL })
+
+| Name | Link |
+| :--- | :--- |
+| 👀 Preview	| <${ previewUrl }> |
+| 🌐 Unique 	| <${ deploymentUniqueURL }> |
+| 🔍 Inspect	| <${ deployment.inspectorUrl }> |
 				`
 
 				const comment = await github.createComment(body)
 				core.info(`Comment created: ${ comment.html_url }`)
 			}
 
 			if (PR_LABELS.length) {
-				core.info('Adding label(s) to PR 🏷️')
 				const labels = await github.addLabel()
 
-				core.info(`Label(s) "${ labels.map((label) => label.name).join(', ') }" added`)
+				core.info(`Label(s) "${ labels.map((label) => label.name).join(', ') }" added to PR 🏷️`)
 			}
 		}
 
-		const deploymentUniqueURL = deploymentUrls[deploymentUrls.length - 1]
+		const deploymentUniqueURL = deploymentUrls.at(-1)
 
 		core.setOutput('PREVIEW_URL', previewUrl)
 		core.setOutput('DEPLOYMENT_URLS', deploymentUrls)
@@ -191,10 +178,10 @@ const run = async () => {
 		const summaryMD = `## Deploy to Vercel ▲
 | Name | Link |
 | :--- | :--- |
-| 🔍 Inspect	| <${ deployment.inspectorUrl }> |
 | 👀 Preview	| <${ previewUrl }> |
 | 🌐 Unique 	| <${ deploymentUniqueURL }> |
-| 🌐 Others 	| ${ deploymentUrls.join('<br>') } |
+| 🌐 Others 	| ${ deploymentUrls.splice(2, -1).join('<br>') } |
+| 🔍 Inspect	| <${ deployment.inspectorUrl }> |
 		`
 
 		await core.summary.addRaw(summaryMD).write()
@@ -203,7 +190,7 @@ const run = async () => {
 		core.exportVariable('VERCEL_PREVIEW_URL', previewUrl)
 		core.exportVariable('VERCEL_DEPLOYMENT_UNIQUE_URL', deploymentUniqueURL)
 
-		core.info('Done')
+		core.info('Done ✅')
 	} catch (err) {
 		await github.updateDeployment('failure')
 		core.error(`Catch Error: ${ err }`)