Implemented when:manual tag

Author: firecow

README.md

@@ -87,7 +87,6 @@ Artifacts works right now, as along as you don't overwirte git tracked files and
 - Verbosity on .gitlab-ci.local.yml overrides and appends.
 
 ## Unsupported tags, will be implemented in order
-- when:manual
 - rules
 - when:on_failure
 - when:delayed

package.json

@@ -11,7 +11,7 @@
     "lint": "tslint --project .",
     "lint-fix": "tslint --fix --project .",
     "ncu": "ncu --semverLevel major -e 2",
-    "test-yml-spec": "node -r source-map-support/register dist/index.js --cwd tests/test-yml-spec"
+    "test-yml-spec": "node -r source-map-support/register dist/index.js manual_job_invoked_from_cli --cwd tests/test-yml-spec"
   },
   "bin": "dist/index.js",
   "dependencies": {

src/index.ts

@@ -52,6 +52,10 @@ const runJobs = async () => {
         const jobNames = `${jobs.map((j) => j.name).join(" ")}`;
         console.log(`=> ${c.yellow(`${stageName}`)} > ${c.blueBright(`${jobNames}`)} ${c.magentaBright("starting")}...`);
         for (const job of jobs) {
+            if (job.isManual() && !argv._.includes(job.name)) {
+                console.log(`${c.blueBright(`${job.name}`)} skipped. Manual job`);
+                continue;
+            }
             const jobPromise = job.start();
             promises.push(jobPromise);
         }

src/job.ts

@@ -22,6 +22,7 @@ export class Job {
     private readonly scripts: string[] = [];
 
     private readonly variables: { [key: string]: string };
+    private readonly when: string;
 
     public constructor(jobData: any, name: string, cwd: any, globals: any) {
         this.name = name;
@@ -49,12 +50,17 @@ export class Job {
         this.scripts = [].concat(jobData.script || []);
 
         const ciDefault = globals.default || {};
+        this.when = jobData.when || "on_success";
         this.beforeScripts = [].concat(jobData.before_script || ciDefault.before_script || globals.before_script || []);
         this.afterScripts = [].concat(jobData.after_script || ciDefault.after_script || globals.after_script || []);
         this.allowFailure = jobData.allow_failure || false;
         this.variables = jobData.variables || {};
     }
 
+    public isManual(): boolean {
+        return this.when === "manual";
+    }
+
     public async start(): Promise<void> {
         this.running = true;
 
@@ -131,7 +137,7 @@ export class Job {
                         if (!l) {
                             return;
                         }
-                        process.stdout.write(`${c.blueBright(`${this.name}`)} ${c.greenBright(">")} ${c.green(`${l}`)}\n`);
+                        process.stdout.write(`${c.blueBright(`${this.name}`)} ${c.greenBright(">")} ${l}\n`);
                     });
                 });
             }

tests/test-yml-spec/.gitlab-ci.yml

@@ -64,3 +64,16 @@ after_script_test:
     - echo "Trying make an error, but my exit code is ignored, cause i'm an after_script"
     - exit 127
 
+manual_job:
+  <<: *tags
+  when: manual
+  stage: last
+  script:
+    - echo "I'm not going to be called"
+
+manual_job_invoked_from_cli:
+  <<: *tags
+  when: manual
+  stage: last
+  script:
+    - echo "I was invoked manually, because 'gitlab-local-pipeline manual_job_invoked_from_cli' was called"