duoops 0.1.0 → 0.1.3

package/README.md

@@ -158,6 +158,23 @@ duoops runner:logs --lines 300
 duoops runner:reinstall-duoops --version 0.1.0
 ```
 
+### 7. Use the GitLab CI Component
+
+Instead of copying `.duoops/measure-component.yml` into every project, you can reference the published component directly:
+
+```yaml
+include:
+  - component: gitlab.com/youneslaaroussi/duoops/templates/duoops-measure-component@v0.1.0
+    inputs:
+      gcp_project_id: "my-project"
+      gcp_instance_id: "1234567890123456789"
+      gcp_zone: "us-central1-a"
+      machine_type: "e2-standard-4"
+      tags: ["gcp"]
+```
+
+Make sure your runner already has DuoOps installed (the provisioning flow handles this) and that `GCP_SA_KEY_BASE64` plus any optional BigQuery variables are set in the project’s CI/CD settings. Pin to a version tag (`@v0.1.0`) and update when you’re ready to adopt new behavior.
+
 ## 🛠️ Development
 
 ### Project Structure
@@ -188,6 +205,13 @@ This compiles the TypeScript CLI and builds the React frontend, copying assets t
 3.  Inspect the publish payload locally with `pnpm pack` (this runs the `prepack` script, which now builds the CLI, portal, and Oclif manifest automatically). Untar the generated `.tgz` if you want to double-check the contents.
 4.  When you're satisfied, publish the package: `pnpm publish --access public`.
 
+## 📦 Publishing the CI Component
+
+1.  Update `templates/duoops-measure-component.yml` and commit the changes.
+2.  Let the `.gitlab-ci.yml` validation job pass (runs automatically on MRs, default branch, and tags).
+3.  Tag the repository (e.g., `git tag v0.1.0 && git push origin v0.1.0`). Consumers reference the component with the tag via the snippet above.
+4.  Update release notes/README with the new component version so teams know what changed.
+
 ## 📄 License
 
 MIT

package/dist/commands/init.js

@@ -78,17 +78,23 @@ const createServiceAccountKey = (projectId, serviceAccount) => {
     fs.unlinkSync(tmpPath);
     return contents.toString('base64');
 };
-const ensureComputeApiEnabled = (projectId, log) => {
+const ensureServiceEnabled = (projectId, service, label, log) => {
     try {
-        log?.(gray('Ensuring Compute Engine API is enabled...'));
-        execSync(`gcloud services enable compute.googleapis.com --project=${projectId} --quiet`, {
+        log?.(gray(`Ensuring ${label} API is enabled...`));
+        execSync(`gcloud services enable ${service} --project=${projectId} --quiet`, {
             stdio: 'ignore',
         });
     }
     catch {
-        log?.(gray('Compute API enablement skipped (it may already be enabled).'));
+        log?.(gray(`${label} API enablement skipped (it may already be enabled).`));
     }
 };
+const ensureComputeApiEnabled = (projectId, log) => {
+    ensureServiceEnabled(projectId, 'compute.googleapis.com', 'Compute Engine', log);
+};
+const ensureMonitoringApiEnabled = (projectId, log) => {
+    ensureServiceEnabled(projectId, 'monitoring.googleapis.com', 'Cloud Monitoring', log);
+};
 const sleep = (ms) => new Promise((resolve) => {
     setTimeout(resolve, ms);
 });
@@ -440,6 +446,7 @@ export default class Init extends Command {
             message: 'Runner tag (GitLab jobs will use this)',
         });
         ensureComputeApiEnabled(gcpProjectId, (message) => this.log(message));
+        ensureMonitoringApiEnabled(gcpProjectId, (message) => this.log(message));
         let runnerToken = tryCreateRunnerToken(projectPath, vmName, runnerTag);
         if (!runnerToken) {
             this.log(gray('Unable to create a runner token automatically. Generate one in your GitLab project (Settings → CI/CD → Runners) and paste it below.'));

package/oclif.manifest.json

@@ -171,96 +171,6 @@
         "logs.js"
       ]
     },
-    "pipelines:list": {
-      "aliases": [],
-      "args": {
-        "project": {
-          "description": "Project ID or path (e.g. group/project)",
-          "name": "project",
-          "required": false
-        }
-      },
-      "description": "List GitLab CI pipelines for a project",
-      "examples": [
-        "<%= config.bin %> <%= command.id %> group/my-project",
-        "<%= config.bin %> <%= command.id %> 123 --limit 20 --ref main"
-      ],
-      "flags": {
-        "limit": {
-          "char": "n",
-          "description": "Maximum number of pipelines to return",
-          "name": "limit",
-          "default": 10,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "ref": {
-          "description": "Filter by branch or tag",
-          "name": "ref",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "status": {
-          "description": "Filter by status (created, pending, running, success, failed, canceled, skipped, manual, scheduled)",
-          "name": "status",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "pipelines:list",
-      "pluginAlias": "duoops",
-      "pluginName": "duoops",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "pipelines",
-        "list.js"
-      ]
-    },
-    "pipelines:show": {
-      "aliases": [],
-      "args": {
-        "project": {
-          "description": "Project ID (e.g. 123456)",
-          "name": "project",
-          "required": true
-        },
-        "pipeline_id": {
-          "description": "Pipeline ID",
-          "name": "pipeline_id",
-          "required": true
-        }
-      },
-      "description": "Show pipeline details and jobs",
-      "examples": [
-        "<%= config.bin %> <%= command.id %> 12345 67890"
-      ],
-      "flags": {},
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "pipelines:show",
-      "pluginAlias": "duoops",
-      "pluginName": "duoops",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "pipelines",
-        "show.js"
-      ]
-    },
     "measure:calculate": {
       "aliases": [],
       "args": {},
@@ -410,6 +320,96 @@
         "seed.js"
       ]
     },
+    "pipelines:list": {
+      "aliases": [],
+      "args": {
+        "project": {
+          "description": "Project ID or path (e.g. group/project)",
+          "name": "project",
+          "required": false
+        }
+      },
+      "description": "List GitLab CI pipelines for a project",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> group/my-project",
+        "<%= config.bin %> <%= command.id %> 123 --limit 20 --ref main"
+      ],
+      "flags": {
+        "limit": {
+          "char": "n",
+          "description": "Maximum number of pipelines to return",
+          "name": "limit",
+          "default": 10,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "ref": {
+          "description": "Filter by branch or tag",
+          "name": "ref",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "status": {
+          "description": "Filter by status (created, pending, running, success, failed, canceled, skipped, manual, scheduled)",
+          "name": "status",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "pipelines:list",
+      "pluginAlias": "duoops",
+      "pluginName": "duoops",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "pipelines",
+        "list.js"
+      ]
+    },
+    "pipelines:show": {
+      "aliases": [],
+      "args": {
+        "project": {
+          "description": "Project ID (e.g. 123456)",
+          "name": "project",
+          "required": true
+        },
+        "pipeline_id": {
+          "description": "Pipeline ID",
+          "name": "pipeline_id",
+          "required": true
+        }
+      },
+      "description": "Show pipeline details and jobs",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> 12345 67890"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "pipelines:show",
+      "pluginAlias": "duoops",
+      "pluginName": "duoops",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "pipelines",
+        "show.js"
+      ]
+    },
     "runner:logs": {
       "aliases": [],
       "args": {},
@@ -480,5 +480,5 @@
       ]
     }
   },
-  "version": "0.1.0"
+  "version": "0.1.3"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "duoops",
   "description": "Toolset for Explainable and Sustainable CI on Gitlab.",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "author": "Younes Laaroussi",
   "bin": {
     "duoops": "./bin/run.js"
@@ -88,16 +88,21 @@
       }
     }
   },
-  "repository": "youneslaaroussi/duoops",
-  "publishConfig": {
-    "access": "public"
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/youneslaaroussi/duoops.git"
   },
-  "types": "dist/index.d.ts",
   "scripts": {
     "build": "shx rm -rf dist && tsc -b && pnpm --filter portal run build && shx cp -r portal/dist dist/portal",
     "lint": "eslint --ignore-pattern \"portal/**\"",
+    "postpack": "shx rm -f oclif.manifest.json",
     "posttest": "pnpm run lint",
+    "prepack": "pnpm run build && oclif manifest && oclif readme",
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
     "version": "oclif readme && git add README.md"
-  }
-}
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "types": "dist/index.d.ts"
+}