feat: Add a link to understand what's currently deployed

Before deploying, one might want to check if the previous occupant has finished their work.
guardian · Dec 6, 2023 · 604fb24 · 604fb24
1 parent 2e8038d
commit 604fb24
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/dist/index.js b/dist/index.js
@@ -63728,13 +63728,20 @@ function getPreviewUrl(config) {
   url.searchParams.set("updateStrategy", "MostlyHarmless");
   return url;
 }
+function getWhatsOnUrl(config) {
+  const url = new URL("https://riffraff.gutools.co.uk/deployment/history");
+  url.searchParams.set("projectName", config.projectName);
+  url.searchParams.set("stage", config.commentingStage);
+  return url;
+}
 var marker = (projectName) => {
   return `<!-- guardian/actions-riff-raff for ${projectName} -->`;
 };
 function getCommentMessage(config) {
   const { buildNumber, commentingStage, projectName } = config;
   const deployUrl = getDeployUrl(config).toString();
   const previewUrl = getPreviewUrl(config).toString();
+  const whatsOnUrl = getWhatsOnUrl(config).toString();
   const mainMessage = `[Deploy build ${buildNumber} of \`${projectName}\` to ${commentingStage}](${deployUrl})`;
   return [
     `### ${mainMessage}`,
@@ -63743,6 +63750,7 @@ function getCommentMessage(config) {
     "",
     `- ${mainMessage}`,
     `- [Deploy parts of build ${buildNumber} to ${commentingStage} by previewing it first](${previewUrl})`,
+    `- [What's on ${commentingStage} right now?](${whatsOnUrl})`,
     "</details>",
     "",
     "---",

diff --git a/src/pr-comment.ts b/src/pr-comment.ts
@@ -25,6 +25,15 @@ function getPreviewUrl(config: PullRequestCommentConfig): URL {
 	return url;
 }
 
+function getWhatsOnUrl(config: PullRequestCommentConfig): URL {
+	const url = new URL('https://riffraff.gutools.co.uk/deployment/history');
+
+	url.searchParams.set('projectName', config.projectName);
+	url.searchParams.set('stage', config.commentingStage);
+
+	return url;
+}
+
 const marker = (projectName: string) => {
 	return `<!-- guardian/actions-riff-raff for ${projectName} -->`;
 };
@@ -33,6 +42,7 @@ function getCommentMessage(config: PullRequestCommentConfig): string {
 	const { buildNumber, commentingStage, projectName } = config;
 	const deployUrl = getDeployUrl(config).toString();
 	const previewUrl = getPreviewUrl(config).toString();
+	const whatsOnUrl = getWhatsOnUrl(config).toString();
 
 	const mainMessage = `[Deploy build ${buildNumber} of \`${projectName}\` to ${commentingStage}](${deployUrl})`;
 
@@ -43,6 +53,7 @@ function getCommentMessage(config: PullRequestCommentConfig): string {
 		'',
 		`- ${mainMessage}`,
 		`- [Deploy parts of build ${buildNumber} to ${commentingStage} by previewing it first](${previewUrl})`,
+		`- [What's on ${commentingStage} right now?](${whatsOnUrl})`,
 		'</details>',
 		'',
 		'---',