fix: working

karlbohlmark · karlbohlmark · commit 66a6d58a3e71 · 2021-02-14T11:05:18.000+01:00
diff --git a/README.md b/README.md
@@ -1,128 +1,7 @@
-# node-gitlab-ci
-
-**Dynamically create your `.gitlab-ci.yml` from TypeScript `.ts` files!**
-
-## Installation
-
-First of all navigate to your repository and install the package via `yarn` or `npm`:
-
-```bash
-# Yarn
-yarn add -D node-gitlab-ci
-
-# NPM
-npm install --save-dev node-gitlab-ci
-```
-
-Afterwards, create a `.gitlab-ci.yml` file with the following content:
-
-```yml
-# CI pipeline is dynamically created through `node-gitlab-ci`, please checkout `.gitlab-ci.ts`!
-
-ts config:
-    image: devowliode/node-gitlab-ci:latest
-    stage: build
-    script: node-gitlab-ci create-yml
-    artifacts:
-        paths:
-            - .gitlab-ci.ts.yml
-
-trigger pipeline:
-    stage: test
-    trigger:
-        strategy: depend
-        include:
-            - artifact: .gitlab-ci.ts.yml
-              job: ts config
-```
-
-What does this mean? The first job creates the `.gitlab-ci.ts.yml` file dynamically and the second job triggers the child pipeline. Learn more about it [here](https://docs.gitlab.com/ee/ci/parent_child_pipelines.html). It is recommend to add `.gitlab-ci.ts.yml` to your `.gitignore` file.
+# gitlab-yml
 
 ## Usage
 
-### Your first `.gitlab-ci.ts`
-
-It is a good practice to create a root `.gitlab-ci.ts` in your repository:
-
-```ts
-import { Config, CreateConfigFunction } from "node-gitlab-ci";
-
-const createConfig: CreateConfigFunction = async () => {
-    const config = new Config();
-
-    config.stages("build", "test");
-
-    config.defaults({
-        image: "alpine:latest",
-    });
-
-    // Setting variables globally or per job
-    config.variable("DOCKER_DRIVER", "overlay2");
-
-    // Run a job only in production branch
-    config.job(
-        "only production",
-        {
-            only: {
-                refs: ["master"],
-            },
-        },
-        true // Creates a hidden job (prefixed with a dot)
-    );
-
-    // Allows you to include further configurations by glob patterns
-    await config.include(__dirname, ["devops/.gitlab/*.ts"]);
-    await config.include(__dirname, ["packages/*/devops/.gitlab/.gitlab-ci.ts"]);
-
-    return config;
-};
-
-export { createConfig };
-```
-
-The complete GitLab CI [pipeline configuration](https://docs.gitlab.com/ee/ci/yaml/) is typed. Give it a try within your IDE and autocomplete!
-
-**Note**: You can not `import` (ES6) or `require` (ES5) all your installed modules. At the time of creating the dynamic pipeline, it is executed within [`devowliode/node-gitlab-ci`](https://hub.docker.com/r/devowliode/node-gitlab-ci) docker container and there are only the `node` modules like `fs`, `path`, ... available. Please read more about it below "Use installed modules".
-
-### Dry run locally
-
-If you have successfully created the above file open a terminal session, navigate to your repository and:
-
-```bash
-# Yarn
-yarn node-gitlab-ci create-yml
-
-# NPM
-npx node-gitlab-ci create-yml
-```
-
-A file `.gitlab-ci.ts.yml` will be created.
-
-### How `include` works
-
-The most interesting part of `node-gitlab-ci` is how `include` works (for example you are using `yarn workspaces` or `lerna`). With `Config#include` you can dynamically include files by a glob pattern:
-
-```ts
-// Do not forget the await!
-await config.include(__dirname, ["packages/*/devops/.gitlab/.gitlab-ci.ts"]);
-```
-
-The extension file `packages/test/devops/.gitlab/.gitlab-ci.ts` must look like this:
-
-```ts
-import { ExtendConfigFunction } from "node-gitlab-ci";
-
-const extendConfig: ExtendConfigFunction = async (config) => {
-    // Create a job
-    config.job(/* [...] */);
-
-    // You can include further files
-    await config.include(__dirname, ["./stage-*.ts"]);
-};
-
-export { extendConfig };
-```
-
 ### How `extends` work
 
 `node-gitlab-ci` resolves automatically the [`extends`](https://docs.gitlab.com/ee/ci/yaml/#extends) keyword for you so you can fully profit from nested jobs without limitations (e. g. nested `extends` with same keys like `only` are no covered by GitLab CI). This is done a **deep merge** mechanism:
diff --git a/lib/config/config.js b/lib/config/config.js
@@ -72,7 +72,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Config = void 0;
 var deepmerge_1 = __importDefault(require("deepmerge"));
 var glob_1 = require("glob");
-var node_1 = require("@gitbeaker/node");
 var child_process_1 = require("child_process");
 /**
  * A global OOP-style GitLab CI configurator.
@@ -203,10 +202,10 @@ var Config = /** @class */ (function () {
         var useName = hidden && !name.startsWith(".") ? "." + name : name;
         if (!this.plain.jobs[useName]) {
             this.plain.jobs[useName] = job;
-            console.log("Job \"" + useName + "\" created successfully!");
+            // console.log(`Job "${useName}" created successfully!`);
         }
         else {
-            console.info("Job \"" + useName + "\" already exists, skipping...");
+            // console.info(`Job "${useName}" already exists, skipping...`);
         }
     };
     /**
@@ -292,26 +291,6 @@ var Config = /** @class */ (function () {
         delete copy.jobs;
         return copy;
     };
-    Object.defineProperty(Config.prototype, "api", {
-        /**
-         * Get the REST API handler.
-         *
-         * @see https://www.npmjs.com/package/node-gitlab
-         */
-        get: function () {
-            if (!this.gapi) {
-                this.gapi = new node_1.Gitlab({
-                    host: process.env.CI_API_V4_URL,
-                    token: process.env.GITLAB_TOKEN,
-                    jobToken: process.env.CI_JOB_TOKEN,
-                    rejectUnauthorized: true,
-                });
-            }
-            return this.gapi;
-        },
-        enumerable: false,
-        configurable: true
-    });
     /**
      * Check if files got changed by a commit by a regexp. E. g. `^\.vscode\/launch\.json$`.
      */
@@ -354,7 +333,7 @@ var Config = /** @class */ (function () {
                     jobKey = "." + from;
                 }
                 if (!jobKey) {
-                    console.warn("The job \"" + from + "\" does not exist, skipping...");
+                    // console.warn(`The job "${from}" does not exist, skipping...`);
                     continue;
                 }
                 var jobObj = pipeline.jobs[jobKey];
diff --git a/lib/index.js b/lib/index.js
@@ -11,11 +11,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-var commander_1 = require("commander");
-require("./create-yml");
-var program = commander_1.parse(process.argv);
-// If no argument is passed show help
-if (process.argv.length < 3) {
-    program.help();
-}
 __exportStar(require("./config"), exports);
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-    "name": "gitlab-ts",
+    "name": "gitlab-yml",
     "version": "0.1.0",
     "description": "Create GitLab CI pipelines with TypeScript.",
     "scripts": {
@@ -51,8 +51,6 @@
         "endOfLine": "lf"
     },
     "dependencies": {
-        "@gitbeaker/node": "^23.2.0",
-        "commander": "^5.1.0",
         "deepmerge": "^4.2.2",
         "glob": "^7.1.6",
         "ts-node": "^8.10.1",
diff --git a/src/config/config.ts b/src/config/config.ts
@@ -1,20 +1,11 @@
 import { GitLabCi, JobDefinition } from ".";
 import merge from "deepmerge";
 import { sync as globSync } from "glob";
-import { Gitlab } from "@gitbeaker/node";
 import { execSync } from "child_process";
 
 type JobDefinitionExtends = JobDefinition & { needsExtends?: string[] };
 type MacroArgs = {};
 
-type ConstructedType<Constructor> = Constructor extends {
-    new (...args: any[]): infer B;
-}
-    ? B
-    : never;
-
-type GitlabType = ConstructedType<typeof Gitlab>;
-
 /**
  * A global OOP-style GitLab CI configurator.
  */
@@ -35,11 +26,6 @@ class Config {
      */
     private patchers: Array<(plain: GitLabCi) => void> = [];
 
-    /**
-     * REST API handler.
-     */
-    private gapi?: GitlabType;
-
     /**
      * The top-level `workflow:` key applies to the entirety of a pipeline, and will determine whether
      * or not a pipeline is created. It currently accepts a single `rules:` key that operates similarly
@@ -158,9 +144,9 @@ class Config {
 
         if (!this.plain.jobs[useName]) {
             this.plain.jobs[useName] = job;
-            console.log(`Job "${useName}" created successfully!`);
+            // console.log(`Job "${useName}" created successfully!`);
         } else {
-            console.info(`Job "${useName}" already exists, skipping...`);
+            // console.info(`Job "${useName}" already exists, skipping...`);
         }
     }
 
@@ -231,24 +217,6 @@ class Config {
 
         return copy;
     }
-
-    /**
-     * Get the REST API handler.
-     *
-     * @see https://www.npmjs.com/package/node-gitlab
-     */
-    public get api() {
-        if (!this.gapi) {
-            this.gapi = new Gitlab({
-                host: process.env.CI_API_V4_URL,
-                token: process.env.GITLAB_TOKEN,
-                jobToken: process.env.CI_JOB_TOKEN,
-                rejectUnauthorized: true,
-            }) as GitlabType;
-        }
-        return this.gapi;
-    }
-
     /**
      * Check if files got changed by a commit by a regexp. E. g. `^\.vscode\/launch\.json$`.
      */
@@ -291,7 +259,7 @@ class Config {
                 }
 
                 if (!jobKey) {
-                    console.warn(`The job "${from}" does not exist, skipping...`);
+                    // console.warn(`The job "${from}" does not exist, skipping...`);
                     continue;
                 }
                 const jobObj = pipeline.jobs[jobKey];
diff --git a/src/config/types/artifacts.ts b/src/config/types/artifacts.ts
@@ -5,7 +5,7 @@ type ArtifactsDefinition = {
     /**
      * @see https://docs.gitlab.com/ee/ci/yaml/#artifactspaths
      */
-    paths: string[];
+    paths?: string[];
     /**
      * @see https://docs.gitlab.com/ee/ci/yaml/#artifactsexpose_as
      */
diff --git a/src/config/types/only.ts b/src/config/types/only.ts
@@ -1,10 +1,16 @@
-type OnlyExpression = {
-    refs?: string[];
-    variables?: string[];
-    changes?: string[];
-    kubernetes?: "active";
-};
+type OnlyExpression =
+    | {
+          refs?: RefList;
+          variables?: string[];
+          changes?: string[];
+          kubernetes?: "active";
+      }
+    | RefList;
 
 type ExpectExpression = OnlyExpression;
 
+type RefList = Ref[];
+
+type Ref = string | RegExp;
+
 export { OnlyExpression, ExpectExpression };
diff --git a/src/config/types/script.ts b/src/config/types/script.ts
@@ -1,6 +1,6 @@
 /**
  * @see https://docs.gitlab.com/ee/ci/yaml/#script
  */
-type ScriptDefinition = string[];
+type ScriptDefinition = string[] | string;
 
 export { ScriptDefinition };
diff --git a/src/index.ts b/src/index.ts
@@ -1,13 +1,3 @@
 #!/usr/bin/env node
 
-import { parse } from "commander";
-import "./create-yml";
-
-const program = parse(process.argv);
-
-// If no argument is passed show help
-if (process.argv.length < 3) {
-    program.help();
-}
-
 export * from "./config";
