feat: Report repo changes as a patch

Author: kgilpin

.gitignore

@@ -1,6 +1,11 @@
+# You know why
 node_modules
-
 yarn-debug.log*
 yarn-error.log*
 
+# Temporary build output
 build
+
+# Files created when testing this action on itself.
+appmap.yml
+patch

action.yml

@@ -14,6 +14,9 @@ inputs:
     description: Enable verbose logging.
     required: false
     default: false
+outputs:
+  patch:
+    description: Patch file of changes made by the installer.
 runs:
   using: 'node16'
   main: 'dist/index.js'

dist/index.js

@@ -18,6 +18,7 @@
     "typescript": "^5.0.2"
   },
   "dependencies": {
+    "@actions/artifact": "^1.1.1",
     "@actions/core": "^1.10.0",
     "@actions/github": "^5.1.1",
     "node-fetch": "^2"

dist/index.js.map

@@ -1,10 +1,11 @@
-import {chmod, writeFile} from 'fs/promises';
+import {chmod, readFile, writeFile} from 'fs/promises';
 import {tmpdir} from 'os';
 import {join} from 'path';
 import {downloadFile} from './downloadFile';
 import {executeCommand} from './executeCommand';
 
 export interface Logger {
+  debug(message: string): void;
   info(message: string): void;
   warn(message: string): void;
 }
@@ -25,12 +26,21 @@ export default class Installer {
 
   async installAppMapLibrary() {
     if (this.appmapConfig) {
-      await writeFile('.appmap.yml', this.appmapConfig);
+      this.logger.info(`Installing the appmap.yml configuration provided by action input.`);
+      await writeFile('appmap.yml', this.appmapConfig);
     }
     await executeCommand(
       `${this.appmapToolsPath} install --no-interactive --no-overwrite-appmap-config`
     );
 
     this.logger.info(`AppMap language library has been installed and configured.`);
   }
+
+  async buildPatchFile() {
+    await executeCommand(`git add -N .`);
+    await executeCommand(`git diff > patch`);
+    const patch = await readFile('patch', 'utf8');
+    this.logger.debug(`Patch file contents:\n${patch}`);
+    return 'patch';
+  }
 }

dist/licenses.txt

@@ -1,8 +1,19 @@
 import * as core from '@actions/core';
+import * as artifact from '@actions/artifact';
+import assert from 'assert';
 import Installer, {Logger} from './Installer';
 import verbose from './verbose';
+import {readFile} from 'fs/promises';
+
+type UploadArtifact = (path: string) => Promise<void>;
+
+let uploadArtifact: UploadArtifact | undefined;
 
 class ActionLogger implements Logger {
+  debug(message: string): void {
+    core.debug(message);
+  }
+
   info(message: string): void {
     core.info(message);
   }
@@ -16,13 +27,22 @@ function usage(): string {
   return `Usage: node ${process.argv[1]} <appmap-tools-url>`;
 }
 
+async function uploadPatchFile(path: string) {
+  core.setOutput('patch', await readFile(path, 'utf8'));
+  const upload = artifact.create();
+  await upload.uploadArtifact('patch', [path], '.');
+}
+
 function runInGitHub(): Installer {
   core.debug(`Env var 'CI' is set. Running as a GitHub action.`);
   verbose(core.getBooleanInput('verbose'));
   const appmapConfig = core.getInput('appmap-config');
   const appmapToolsURL = core.getInput('tools-url');
   const installer = new Installer(appmapToolsURL, new ActionLogger());
   if (appmapConfig) installer.appmapConfig = appmapConfig;
+
+  uploadArtifact = uploadPatchFile;
+
   return installer;
 }
 
@@ -31,6 +51,10 @@ function runAsScript(): Installer {
   const appmapToolsURL = process.argv[2];
   if (!appmapToolsURL) throw new Error(usage());
   const installer = new Installer(appmapToolsURL);
+
+  uploadArtifact = (path: string) =>
+    Promise.resolve(console.log(`Repository changes stored in patch file: ${path}`));
+
   return installer;
 }
 
@@ -41,4 +65,7 @@ function runAsScript(): Installer {
 
   await installer.installAppMapTools();
   await installer.installAppMapLibrary();
+  const patchFile = await installer.buildPatchFile();
+  assert(uploadArtifact);
+  await uploadArtifact(patchFile);
 })();