Merge pull request #23 from guardian/nicl/record-build-tool

Record build tool
guardian · Dec 2, 2022 · f2b0e16 · f2b0e16
2 parents 49c3b20 + 37bc7e1
commit f2b0e16
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 19 deletions.
diff --git a/dist/index.js b/dist/index.js
@@ -38386,14 +38386,15 @@ function getConfiguration() {
 }
 
 // src/riffraff.ts
-var manifest = (projectName, buildNumber, branch, vcsURL2, revision) => {
+var manifest = (projectName, buildNumber, branch, vcsURL2, revision, buildTool) => {
   return {
     branch,
     vcsURL: vcsURL2,
     revision,
     buildNumber,
     projectName,
-    startTime: new Date()
+    startTime: new Date(),
+    buildTool
   };
 };
 var riffraffPrefix = (m) => {
@@ -38429,7 +38430,7 @@ var sync = async (store, dir, bucket, keyPrefix) => {
 };
 
 // src/index.ts
-var main = async () => {
+var main = async (options) => {
   const config = getConfiguration();
   core4.debug(JSON.stringify(config, null, 2));
   const {
@@ -38448,14 +38449,17 @@ var main = async () => {
     buildNumber,
     branchName2,
     vcsURL2,
-    revision
+    revision,
+    "guardian/actions-riff-raff"
   );
   const manifestJSON = JSON.stringify(mfest);
   const stagingDir = stagingDirInput ?? fs3.mkdtempSync("staging-");
-  await core4.summary.addHeading("Riff-Raff").addTable([
-    ["Project name", projectName],
-    ["Build number", buildNumber]
-  ]).write();
+  if (options.WithSummary) {
+    await core4.summary.addHeading("Riff-Raff").addTable([
+      ["Project name", projectName],
+      ["Build number", buildNumber]
+    ]).write();
+  }
   core4.info("writing rr yaml...");
   write(`${stagingDir}/riff-raff.yaml`, dump(riffRaffYaml));
   deployments.forEach((deployment) => {
@@ -38478,7 +38482,7 @@ var main = async () => {
   core4.info("Upload complete.");
 };
 if (require.main === module) {
-  main().catch((err) => {
+  main({ WithSummary: true }).catch((err) => {
     if (err instanceof Error) {
       core4.error(err);
       core4.setFailed(err.message);

diff --git a/src/index.test.ts b/src/index.test.ts
@@ -48,7 +48,7 @@ config: |
         publicReadAcl: false`;
 
 		readConfig(input);
-		await main();
+		await main({ WithSummary: false });
 
 		const got = walk(stagingDir, (path: string) => path);
 

diff --git a/src/index.ts b/src/index.ts
@@ -8,7 +8,11 @@ import type { Deployment } from './riffraff';
 import { manifest, riffraffPrefix } from './riffraff';
 import { S3Store, sync } from './s3';
 
-export const main = async (): Promise<void> => {
+interface Options {
+	WithSummary: boolean; // Use to disable summary when running locally.
+}
+
+export const main = async (options: Options): Promise<void> => {
 	const config = getConfiguration();
 
 	core.debug(JSON.stringify(config, null, 2));
@@ -31,20 +35,23 @@ export const main = async (): Promise<void> => {
 		branchName,
 		vcsURL,
 		revision,
+		'guardian/actions-riff-raff',
 	);
 	const manifestJSON = JSON.stringify(mfest);
 
 	// Ensure unique name as multiple steps may run using this action within the
 	// same workflow (this has happened!).
 	const stagingDir = stagingDirInput ?? fs.mkdtempSync('staging-');
 
-	await core.summary
-		.addHeading('Riff-Raff')
-		.addTable([
-			['Project name', projectName],
-			['Build number', buildNumber],
-		])
-		.write();
+	if (options.WithSummary) {
+		await core.summary
+			.addHeading('Riff-Raff')
+			.addTable([
+				['Project name', projectName],
+				['Build number', buildNumber],
+			])
+			.write();
+	}
 
 	core.info('writing rr yaml...');
 	write(`${stagingDir}/riff-raff.yaml`, yaml.dump(riffRaffYaml));
@@ -79,7 +86,7 @@ export const main = async (): Promise<void> => {
 
 // execute only if invoked as main script (rather than test)
 if (require.main === module) {
-	main().catch((err) => {
+	main({ WithSummary: true }).catch((err) => {
 		if (err instanceof Error) {
 			core.error(err);
 			core.setFailed(err.message);

diff --git a/src/riffraff.test.ts b/src/riffraff.test.ts
@@ -10,6 +10,7 @@ describe('riffraff', () => {
 			buildNumber: '10',
 			projectName: 'example',
 			startTime: new Date(),
+			buildTool: 'guardian/actions-riff-raff',
 		};
 
 		const got = riffraffPrefix(m);

diff --git a/src/riffraff.ts b/src/riffraff.ts
@@ -5,6 +5,7 @@ export type Manifest = {
 	buildNumber: string;
 	projectName: string;
 	startTime: Date;
+	buildTool: string;
 };
 
 export const manifest = (
@@ -13,6 +14,7 @@ export const manifest = (
 	branch: string,
 	vcsURL: string,
 	revision: string,
+	buildTool: string,
 ): Manifest => {
 	return {
 		branch,
@@ -21,6 +23,7 @@ export const manifest = (
 		buildNumber,
 		projectName,
 		startTime: new Date(),
+		buildTool,
 	};
 };