Merge pull request #6 from getappmap/feat/expand-inputs

feat: Add additional installer options

Author: kgilpin

.github/workflows/appmap-archive.yml

@@ -18,6 +18,8 @@ jobs:
       - name: Install and configure AppMap tools
         uses: ./
         id: install-appmap
+        with:
+          verbose: true
       - name: Build AppMaps
         run: yarn appmap
       - name: Archive AppMaps

.github/workflows/main.yml

@@ -8,9 +8,9 @@ jobs:
     runs-on: ubuntu-latest
     name: Build, test and package
     steps:
-      - name: Checkout step
+      - name: Checkout
         uses: actions/checkout@v3
-      - name: Install dependencies
+      - name: Install dependency libraries
         run: yarn install
       - name: Build
         run: yarn build

README.md

@@ -17,6 +17,11 @@ can also add the following step to your workflow to commit the changes automatic
         uses: EndBug/add-and-commit@v9
 ```
 
+## Prerequisites
+
+Before running this action, ensure that the programming language and package manager used by your
+project are installed and available.
+
 ## Development
 
 ```
@@ -35,6 +40,6 @@ $ yarn package
 
 ## TODO
 
-- [ ] Update description to action.yml.
 - [ ] Update repo description in GitHub.
 - [ ] Use appmap-action-utils
+- [x] Update description in action.yml.

action.yml

@@ -5,6 +5,17 @@ description:
 inputs:
   appmap-config:
     description: appmap.yml configuration contents.
+  project-type:
+    description: |
+      Type of project to be configured. Valid values include bundler, yarn, npm, gradle, maven, 
+      pip, pipenv, and poetry. Consult https://appmap.io/docs/add-appmap-to-a-project.html for
+      more information.
+  build-file:
+    description: |
+      Build file to be configured, in case of ambiguity. This is an advanced option.
+  installer-name:
+    description: |
+      Installer name to be used, in case of ambiguity. This is an advanced option.
   tools-url:
     description: URL to the AppMap tools.
     default: https://github.com/getappmap/appmap-js/releases/download/%40appland%2Fappmap-preflight-v1.0-pre.1/appmap-preflight-linux-x64

dist/index.js

@@ -63,7 +63,14 @@ class Installer {
                 (0, log_1.default)(log_1.LogLevel.Info, `Installing the appmap.yml configuration provided by action input.`);
                 yield (0, promises_1.writeFile)('appmap.yml', this.appmapConfig);
             }
-            yield (0, executeCommand_1.executeCommand)(`${this.appmapToolsPath} install --no-interactive --no-overwrite-appmap-config`);
+            let cmd = `${this.appmapToolsPath} install --no-interactive --no-overwrite-appmap-config`;
+            if (this.projectType)
+                cmd += ` --project-type ${this.projectType}`;
+            if (this.buildFile)
+                cmd += ` --build-file ${this.buildFile}`;
+            if (this.installerName)
+                cmd += ` --installer-name ${this.installerName}`;
+            yield (0, executeCommand_1.executeCommand)(cmd);
             (0, log_1.default)(log_1.LogLevel.Info, `AppMap language library has been installed and configured.`);
         });
     }
@@ -262,14 +269,22 @@ function uploadPatchFile(path) {
         yield upload.uploadArtifact('appmap-install.patch', [path], '.');
     });
 }
+const Options = {
+    'appmap-config': 'appmapConfig',
+    'project-type': 'projectType',
+    'installer-name': 'installerName',
+    'build-file': 'buildFile',
+};
 function runInGitHub() {
     return __awaiter(this, void 0, void 0, function* () {
         (0, verbose_1.default)(core.getBooleanInput('verbose'));
-        const appmapConfig = core.getInput('appmap-config');
         const appmapToolsURL = core.getInput('tools-url');
         const installer = new Installer_1.default(appmapToolsURL);
-        if (appmapConfig)
-            installer.appmapConfig = appmapConfig;
+        for (const [inputName, fieldName] of Object.entries(Options)) {
+            const value = core.getInput(inputName);
+            if (value)
+                installer[fieldName] = value;
+        }
         yield installer.installAppMapTools();
         yield installer.installAppMapLibrary();
         const patch = yield installer.buildPatchFile();

dist/index.js.map

@@ -8,6 +8,9 @@ import log, {LogLevel} from './log';
 export default class Installer {
   public appmapConfig?: string;
   public appmapToolsPath: string;
+  public projectType?: string;
+  public installerName?: string;
+  public buildFile?: string;
 
   constructor(public appmapToolsURL: string) {
     this.appmapToolsPath = join(tmpdir(), 'appmap');
@@ -24,9 +27,11 @@ export default class Installer {
       log(LogLevel.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`
-    );
+    let cmd = `${this.appmapToolsPath} install --no-interactive --no-overwrite-appmap-config`;
+    if (this.projectType) cmd += ` --project-type ${this.projectType}`;
+    if (this.buildFile) cmd += ` --build-file ${this.buildFile}`;
+    if (this.installerName) cmd += ` --installer-name ${this.installerName}`;
+    await executeCommand(cmd);
 
     log(LogLevel.Info, `AppMap language library has been installed and configured.`);
   }

src/Installer.ts

@@ -11,13 +11,23 @@ async function uploadPatchFile(path: string) {
   await upload.uploadArtifact('appmap-install.patch', [path], '.');
 }
 
+const Options: Record<string, keyof Installer> = {
+  'appmap-config': 'appmapConfig',
+  'project-type': 'projectType',
+  'installer-name': 'installerName',
+  'build-file': 'buildFile',
+};
+
 export async function runInGitHub(): Promise<void> {
   verbose(core.getBooleanInput('verbose'));
-  const appmapConfig = core.getInput('appmap-config');
-  const appmapToolsURL = core.getInput('tools-url');
 
+  const appmapToolsURL = core.getInput('tools-url');
   const installer = new Installer(appmapToolsURL);
-  if (appmapConfig) installer.appmapConfig = appmapConfig;
+
+  for (const [inputName, fieldName] of Object.entries(Options)) {
+    const value = core.getInput(inputName);
+    if (value) (installer as any)[fieldName] = value;
+  }
 
   await installer.installAppMapTools();
   await installer.installAppMapLibrary();