@datadog/datadog-ci 0.17.7 → 0.17.11

package/dist/commands/trace/trace.d.ts

@@ -1,7 +1,7 @@
 import { Command } from 'clipanion';
 import { Provider } from './interfaces';
 export declare class TraceCommand extends Command {
-    static usage: import("clipanion/lib/advanced").Usage;
+    static usage: import("clipanion").Usage;
     private command?;
     private config;
     private name?;

package/dist/helpers/__tests__/ci.test.js

@@ -3,126 +3,42 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const ci_1 = require("../ci");
-const user_provided_git_1 = require("../user-provided-git");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
+const ci_1 = require("../ci");
+const user_provided_git_1 = require("../user-provided-git");
+const CI_PROVIDERS = fs_1.default.readdirSync(path_1.default.join(__dirname, 'ci-env'));
 describe('getCIMetadata', () => {
-    const branch = 'fakeBranch';
-    const commit = 'fakeCommitSha';
-    const pipelineURL = 'fakePipelineUrl';
     test('non-recognized CI returns undefined', () => {
         process.env = {};
         expect(ci_1.getCIMetadata()).toBeUndefined();
     });
-    test('circle CI is recognized', () => {
-        process.env = {
-            CIRCLECI: 'true',
-            CIRCLE_BRANCH: branch,
-            CIRCLE_BUILD_URL: pipelineURL,
-            CIRCLE_SHA1: commit,
-        };
-        expect(ci_1.getCIMetadata()).toEqual({
-            ci: {
-                pipeline: { url: pipelineURL },
-                provider: { name: ci_1.CI_ENGINES.CIRCLECI },
-            },
-            git: {
-                branch,
-                commitSha: commit,
-            },
-        });
-    });
-    test('travis CI is recognized', () => {
-        process.env = {
-            TRAVIS: 'true',
-            TRAVIS_BRANCH: branch,
-            TRAVIS_COMMIT: commit,
-            TRAVIS_JOB_WEB_URL: pipelineURL,
-        };
-        expect(ci_1.getCIMetadata()).toEqual({
-            ci: {
-                pipeline: { url: pipelineURL },
-                provider: { name: ci_1.CI_ENGINES.TRAVIS },
-            },
-            git: {
-                branch,
-                commitSha: commit,
-            },
-        });
-    });
-    test('gitlab CI is recognized', () => {
-        process.env = {
-            CI_COMMIT_REF_NAME: branch,
-            CI_COMMIT_SHA: commit,
-            CI_JOB_URL: pipelineURL,
-            GITLAB_CI: 'true',
-        };
-        expect(ci_1.getCIMetadata()).toEqual({
-            ci: {
-                pipeline: { url: pipelineURL },
-                provider: { name: ci_1.CI_ENGINES.GITLAB },
-            },
-            git: {
-                branch,
-                commitSha: commit,
-            },
-        });
-    });
-    test('github actions is recognized', () => {
-        process.env = {
-            GITHUB_ACTIONS: 'true',
-            GITHUB_REF: branch,
-            GITHUB_REPOSITORY: 'DataDog/datadog-ci',
-            GITHUB_RUN_ID: '42',
-            GITHUB_SHA: commit,
-        };
-        const expectedPipelineURL = 'https://github.com/DataDog/datadog-ci/actions/runs/42';
-        expect(ci_1.getCIMetadata()).toEqual({
-            ci: {
-                pipeline: { url: expectedPipelineURL },
-                provider: { name: ci_1.CI_ENGINES.GITHUB },
-            },
-            git: {
-                branch,
-                commitSha: commit,
-            },
-        });
-    });
-    test('jenkins is recognized', () => {
-        process.env = {
-            BUILD_URL: pipelineURL,
-            GIT_BRANCH: branch,
-            GIT_COMMIT: commit,
-            JENKINS_URL: 'https://fakebuildserver.url/',
-        };
-        expect(ci_1.getCIMetadata()).toEqual({
-            ci: {
-                pipeline: { url: pipelineURL },
-                provider: { name: ci_1.CI_ENGINES.JENKINS },
-            },
-            git: {
-                branch,
-                commitSha: commit,
-            },
-        });
+    test('pipeline number is parsed to int or ignored', () => {
+        var _a, _b, _c, _d, _e, _f, _g, _h;
+        process.env = { GITLAB_CI: 'gitlab' };
+        process.env.CI_PIPELINE_IID = '0';
+        expect((_a = ci_1.getCIMetadata()) === null || _a === void 0 ? void 0 : _a.ci.pipeline.number).toBe(0);
+        process.env.CI_PIPELINE_IID = ' \n\r 12345 \n\n ';
+        expect((_b = ci_1.getCIMetadata()) === null || _b === void 0 ? void 0 : _b.ci.pipeline.number).toBe(12345);
+        process.env.CI_PIPELINE_IID = '123.45';
+        expect((_c = ci_1.getCIMetadata()) === null || _c === void 0 ? void 0 : _c.ci.pipeline.number).toBe(123);
+        process.env.CI_PIPELINE_IID = '999b';
+        expect((_d = ci_1.getCIMetadata()) === null || _d === void 0 ? void 0 : _d.ci.pipeline.number).toBe(999);
+        process.env.CI_PIPELINE_IID = '-1';
+        expect((_e = ci_1.getCIMetadata()) === null || _e === void 0 ? void 0 : _e.ci.pipeline.number).toBe(-1);
+        process.env.CI_PIPELINE_IID = '';
+        expect((_f = ci_1.getCIMetadata()) === null || _f === void 0 ? void 0 : _f.ci.pipeline.number).toBeUndefined();
+        process.env.CI_PIPELINE_IID = 'not a number';
+        expect((_g = ci_1.getCIMetadata()) === null || _g === void 0 ? void 0 : _g.ci.pipeline.number).toBeUndefined();
+        process.env.CI_PIPELINE_IID = '$1';
+        expect((_h = ci_1.getCIMetadata()) === null || _h === void 0 ? void 0 : _h.ci.pipeline.number).toBeUndefined();
     });
-    test('jenkins context is recognized', () => {
-        process.env = {
-            BUILD_URL: pipelineURL,
-            GIT_BRANCH: branch,
-            GIT_COMMIT: commit,
-            JENKINS_URL: 'https://fakebuildserver.url/',
-        };
-        expect(ci_1.getCIMetadata()).toEqual({
-            ci: {
-                pipeline: { url: pipelineURL },
-                provider: { name: ci_1.CI_ENGINES.JENKINS },
-            },
-            git: {
-                branch,
-                commitSha: commit,
-            },
+    describe.each(CI_PROVIDERS)('%s', (ciProvider) => {
+        const assertions = require(path_1.default.join(__dirname, 'ci-env', ciProvider));
+        test.each(assertions)('spec %#', (env, tags) => {
+            process.env = env;
+            const expectedMetadata = ciAppTagsToMetadata(tags);
+            expect(ci_1.getCIMetadata()).toEqual(expectedMetadata);
         });
     });
 });
@@ -132,8 +48,7 @@ describe('ci spec', () => {
         const tags = Object.assign(Object.assign({}, ci_1.getCISpanTags()), user_provided_git_1.getUserGitMetadata());
         expect(tags).toEqual({});
     });
-    const ciProviders = fs_1.default.readdirSync(path_1.default.join(__dirname, 'ci-env'));
-    ciProviders.forEach((ciProvider) => {
+    CI_PROVIDERS.forEach((ciProvider) => {
         const assertions = require(path_1.default.join(__dirname, 'ci-env', ciProvider));
         assertions.forEach(([env, expectedSpanTags], index) => {
             test(`reads env info for spec ${index} from ${ciProvider}`, () => {
@@ -144,3 +59,25 @@ describe('ci spec', () => {
         });
     });
 });
+const ciAppTagsToMetadata = (tags) => {
+    const metadata = {
+        ci: { job: {}, pipeline: {}, provider: {}, stage: {} },
+        git: { commit: { author: {}, committer: {} } },
+    };
+    Object.entries(tags).forEach(([tag, value]) => {
+        // Ignore JSON fixtures pipeline number that can't be parsed to numbers
+        if (!value || tag === 'ci.pipeline.number') {
+            return;
+        }
+        // Get Metadata nested property from tag name ('git.commit.author.name')
+        let currentAttr = metadata;
+        // Current attribute up to second to last
+        const properties = tag.split('.');
+        for (let i = 0; i < properties.length - 1; i++) {
+            currentAttr = currentAttr[properties[i]];
+        }
+        const attributeName = properties[properties.length - 1];
+        currentAttr[attributeName] = value;
+    });
+    return metadata;
+};

package/dist/helpers/__tests__/user-provided-git.test.js

@@ -7,7 +7,6 @@ describe('getUserGitMetadata', () => {
         process.env.DD_GIT_COMMIT_SHA = 'DD_GIT_COMMIT_SHA';
         process.env.DD_GIT_REPOSITORY_URL = 'DD_GIT_REPOSITORY_URL';
         process.env.DD_GIT_BRANCH = 'DD_GIT_BRANCH';
-        process.env.DD_GIT_TAG = 'DD_GIT_TAG';
         process.env.DD_GIT_COMMIT_MESSAGE = 'DD_GIT_COMMIT_MESSAGE';
         process.env.DD_GIT_COMMIT_AUTHOR_NAME = 'DD_GIT_COMMIT_AUTHOR_NAME';
         process.env.DD_GIT_COMMIT_AUTHOR_EMAIL = 'DD_GIT_COMMIT_AUTHOR_EMAIL';
@@ -20,7 +19,6 @@ describe('getUserGitMetadata', () => {
             [tags_1.GIT_REPOSITORY_URL]: 'DD_GIT_REPOSITORY_URL',
             [tags_1.GIT_BRANCH]: 'DD_GIT_BRANCH',
             [tags_1.GIT_SHA]: 'DD_GIT_COMMIT_SHA',
-            [tags_1.GIT_TAG]: 'DD_GIT_TAG',
             [tags_1.GIT_COMMIT_MESSAGE]: 'DD_GIT_COMMIT_MESSAGE',
             [tags_1.GIT_COMMIT_COMMITTER_DATE]: 'DD_GIT_COMMIT_COMMITTER_DATE',
             [tags_1.GIT_COMMIT_COMMITTER_EMAIL]: 'DD_GIT_COMMIT_COMMITTER_EMAIL',
@@ -36,7 +34,21 @@ describe('getUserGitMetadata', () => {
         expect(result).toEqual({
             [tags_1.GIT_REPOSITORY_URL]: 'DD_GIT_REPOSITORY_URL',
             [tags_1.GIT_BRANCH]: 'DD_GIT_BRANCH',
+            [tags_1.GIT_COMMIT_MESSAGE]: 'DD_GIT_COMMIT_MESSAGE',
+            [tags_1.GIT_COMMIT_COMMITTER_DATE]: 'DD_GIT_COMMIT_COMMITTER_DATE',
+            [tags_1.GIT_COMMIT_COMMITTER_EMAIL]: 'DD_GIT_COMMIT_COMMITTER_EMAIL',
+            [tags_1.GIT_COMMIT_COMMITTER_NAME]: 'DD_GIT_COMMIT_COMMITTER_NAME',
+            [tags_1.GIT_COMMIT_AUTHOR_DATE]: 'DD_GIT_COMMIT_AUTHOR_DATE',
+            [tags_1.GIT_COMMIT_AUTHOR_EMAIL]: 'DD_GIT_COMMIT_AUTHOR_EMAIL',
+            [tags_1.GIT_COMMIT_AUTHOR_NAME]: 'DD_GIT_COMMIT_AUTHOR_NAME',
+        });
+    });
+    it('overwrites branch when tag is available', () => {
+        process.env.DD_GIT_TAG = 'DD_GIT_TAG';
+        const result = user_provided_git_1.getUserGitMetadata();
+        expect(result).toEqual({
             [tags_1.GIT_TAG]: 'DD_GIT_TAG',
+            [tags_1.GIT_REPOSITORY_URL]: 'DD_GIT_REPOSITORY_URL',
             [tags_1.GIT_COMMIT_MESSAGE]: 'DD_GIT_COMMIT_MESSAGE',
             [tags_1.GIT_COMMIT_COMMITTER_DATE]: 'DD_GIT_COMMIT_COMMITTER_DATE',
             [tags_1.GIT_COMMIT_COMMITTER_EMAIL]: 'DD_GIT_COMMIT_COMMITTER_EMAIL',

package/dist/helpers/__tests__/utils.test.js

@@ -363,3 +363,7 @@ describe('utils', () => {
         }));
     });
 });
+test('removeUndefinedValues', () => {
+    // tslint:disable-next-line: no-null-keyword
+    expect(ciUtils.removeUndefinedValues({ a: 'b', c: 'd', e: undefined, g: null })).toEqual({ a: 'b', c: 'd', g: null });
+});

package/dist/helpers/ci.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCIMetadata = exports.getCISpanTags = exports.CI_ENGINES = void 0;
 const url_1 = require("url");
 const tags_1 = require("./tags");
+const user_provided_git_1 = require("./user-provided-git");
 const utils_1 = require("./utils");
 exports.CI_ENGINES = {
     APPVEYOR: 'appveyor',
@@ -57,12 +58,6 @@ const filterSensitiveInfoFromRepository = (repositoryUrl) => {
         return repositoryUrl;
     }
 };
-const normalizeRef = (ref) => {
-    if (!ref) {
-        return ref;
-    }
-    return ref.replace(/origin\/|refs\/heads\/|tags\//gm, '');
-};
 const getCISpanTags = () => {
     const env = process.env;
     let tags = {};
@@ -125,13 +120,17 @@ const getCISpanTags = () => {
         };
     }
     if (env.GITHUB_ACTIONS || env.GITHUB_ACTION) {
-        const { GITHUB_RUN_ID, GITHUB_WORKFLOW, GITHUB_RUN_NUMBER, GITHUB_WORKSPACE, GITHUB_HEAD_REF, GITHUB_REF, GITHUB_SHA, GITHUB_REPOSITORY, } = env;
-        const repositoryUrl = `https://github.com/${GITHUB_REPOSITORY}.git`;
-        const pipelineURL = `https://github.com/${GITHUB_REPOSITORY}/commit/${GITHUB_SHA}/checks`;
+        const { GITHUB_RUN_ID, GITHUB_WORKFLOW, GITHUB_RUN_NUMBER, GITHUB_WORKSPACE, GITHUB_HEAD_REF, GITHUB_REF, GITHUB_SHA, GITHUB_REPOSITORY, GITHUB_SERVER_URL, } = env;
+        const repositoryUrl = `${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}.git`;
+        let pipelineURL = `${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}`;
+        // Some older versions of enterprise might not have this yet.
+        if (env.GITHUB_RUN_ATTEMPT) {
+            pipelineURL += `/attempts/${env.GITHUB_RUN_ATTEMPT}`;
+        }
         const ref = GITHUB_HEAD_REF || GITHUB_REF || '';
         const refKey = ref.includes('tags') ? tags_1.GIT_TAG : tags_1.GIT_BRANCH;
         tags = {
-            [tags_1.CI_JOB_URL]: pipelineURL,
+            [tags_1.CI_JOB_URL]: `${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/commit/${GITHUB_SHA}/checks`,
             [tags_1.CI_PIPELINE_ID]: GITHUB_RUN_ID,
             [tags_1.CI_PIPELINE_NAME]: GITHUB_WORKFLOW,
             [tags_1.CI_PIPELINE_NUMBER]: GITHUB_RUN_NUMBER,
@@ -156,7 +155,7 @@ const getCISpanTags = () => {
         };
         const isTag = JENKINS_GIT_BRANCH && JENKINS_GIT_BRANCH.includes('tags');
         const refKey = isTag ? tags_1.GIT_TAG : tags_1.GIT_BRANCH;
-        const ref = normalizeRef(JENKINS_GIT_BRANCH);
+        const ref = utils_1.normalizeRef(JENKINS_GIT_BRANCH);
         tags[refKey] = ref;
         let finalPipelineName = '';
         if (JOB_NAME) {
@@ -280,98 +279,65 @@ const getCISpanTags = () => {
         tags[tags_1.GIT_REPOSITORY_URL] = filterSensitiveInfoFromRepository(tags[tags_1.GIT_REPOSITORY_URL]);
     }
     if (tags[tags_1.GIT_BRANCH]) {
-        tags[tags_1.GIT_BRANCH] = normalizeRef(tags[tags_1.GIT_BRANCH]);
+        tags[tags_1.GIT_BRANCH] = utils_1.normalizeRef(tags[tags_1.GIT_BRANCH]);
     }
     if (tags[tags_1.GIT_TAG]) {
-        tags[tags_1.GIT_TAG] = normalizeRef(tags[tags_1.GIT_TAG]);
+        tags[tags_1.GIT_TAG] = utils_1.normalizeRef(tags[tags_1.GIT_TAG]);
     }
     return utils_1.removeEmptyValues(tags);
 };
 exports.getCISpanTags = getCISpanTags;
 const getCIMetadata = () => {
-    const env = process.env;
-    if (env.CIRCLECI) {
-        return {
-            ci: {
-                pipeline: {
-                    url: env.CIRCLE_BUILD_URL,
-                },
-                provider: {
-                    name: exports.CI_ENGINES.CIRCLECI,
-                },
-            },
-            git: {
-                branch: env.CIRCLE_BRANCH,
-                commitSha: env.CIRCLE_SHA1,
-            },
-        };
-    }
-    if (env.TRAVIS) {
-        return {
-            ci: {
-                pipeline: {
-                    url: env.TRAVIS_JOB_WEB_URL,
-                },
-                provider: {
-                    name: exports.CI_ENGINES.TRAVIS,
-                },
-            },
-            git: {
-                branch: env.TRAVIS_BRANCH,
-                commitSha: env.TRAVIS_COMMIT,
-            },
-        };
-    }
-    if (env.GITLAB_CI) {
-        return {
-            ci: {
-                pipeline: {
-                    url: env.CI_JOB_URL,
-                },
-                provider: {
-                    name: exports.CI_ENGINES.GITLAB,
-                },
-            },
-            git: {
-                branch: env.CI_COMMIT_REF_NAME,
-                commitSha: env.CI_COMMIT_SHA,
-            },
-        };
-    }
-    if (env.GITHUB_ACTIONS) {
-        const { GITHUB_REF, GITHUB_SHA, GITHUB_REPOSITORY, GITHUB_RUN_ID } = env;
-        const pipelineURL = `https://github.com/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}`;
-        return {
-            ci: {
-                pipeline: {
-                    url: pipelineURL,
-                },
-                provider: {
-                    name: exports.CI_ENGINES.GITHUB,
-                },
-            },
-            git: {
-                branch: GITHUB_REF,
-                commitSha: GITHUB_SHA,
-            },
-        };
-    }
-    if (env.JENKINS_URL) {
-        const { BUILD_URL, GIT_COMMIT, GIT_BRANCH: JENKINS_GIT_BRANCH } = env;
-        return {
-            ci: {
-                pipeline: {
-                    url: BUILD_URL,
-                },
-                provider: {
-                    name: exports.CI_ENGINES.JENKINS,
-                },
-            },
-            git: {
-                branch: JENKINS_GIT_BRANCH,
-                commitSha: GIT_COMMIT,
-            },
-        };
+    const tags = Object.assign(Object.assign({}, exports.getCISpanTags()), user_provided_git_1.getUserGitMetadata());
+    if (!tags || !Object.keys(tags).length) {
+        return;
     }
+    const metadata = {
+        ci: utils_1.removeUndefinedValues({
+            job: utils_1.removeUndefinedValues({
+                name: tags[tags_1.CI_JOB_NAME],
+                url: tags[tags_1.CI_JOB_URL],
+            }),
+            pipeline: utils_1.removeUndefinedValues({
+                id: tags[tags_1.CI_PIPELINE_ID],
+                name: tags[tags_1.CI_PIPELINE_NAME],
+                number: parsePipelineNumber(tags[tags_1.CI_PIPELINE_NUMBER]),
+                url: tags[tags_1.CI_PIPELINE_URL],
+            }),
+            provider: utils_1.removeUndefinedValues({
+                name: tags[tags_1.CI_PROVIDER_NAME],
+            }),
+            stage: utils_1.removeUndefinedValues({
+                name: tags[tags_1.CI_STAGE_NAME],
+            }),
+            workspace_path: tags[tags_1.CI_WORKSPACE_PATH],
+        }),
+        git: utils_1.removeUndefinedValues({
+            branch: tags[tags_1.GIT_BRANCH],
+            commit: utils_1.removeUndefinedValues({
+                author: utils_1.removeUndefinedValues({
+                    date: tags[tags_1.GIT_COMMIT_AUTHOR_DATE],
+                    email: tags[tags_1.GIT_COMMIT_AUTHOR_EMAIL],
+                    name: tags[tags_1.GIT_COMMIT_AUTHOR_NAME],
+                }),
+                committer: utils_1.removeUndefinedValues({
+                    date: tags[tags_1.GIT_COMMIT_COMMITTER_DATE],
+                    email: tags[tags_1.GIT_COMMIT_COMMITTER_EMAIL],
+                    name: tags[tags_1.GIT_COMMIT_COMMITTER_NAME],
+                }),
+                message: tags[tags_1.GIT_COMMIT_MESSAGE],
+                sha: tags[tags_1.GIT_SHA],
+            }),
+            repository_url: tags[tags_1.GIT_REPOSITORY_URL],
+            tag: tags[tags_1.GIT_TAG],
+        }),
+    };
+    return metadata;
 };
 exports.getCIMetadata = getCIMetadata;
+const parsePipelineNumber = (pipelineNumberStr) => {
+    if (pipelineNumberStr) {
+        const pipelineNumber = parseInt(pipelineNumberStr, 10);
+        return isFinite(pipelineNumber) ? pipelineNumber : undefined;
+    }
+};

package/dist/helpers/interfaces.d.ts

@@ -2,16 +2,42 @@ import { AxiosPromise, AxiosRequestConfig, AxiosResponse } from 'axios';
 import { CI_JOB_NAME, CI_JOB_URL, CI_PIPELINE_ID, CI_PIPELINE_NAME, CI_PIPELINE_NUMBER, CI_PIPELINE_URL, CI_PROVIDER_NAME, CI_STAGE_NAME, CI_WORKSPACE_PATH, GIT_BRANCH, GIT_COMMIT_AUTHOR_DATE, GIT_COMMIT_AUTHOR_EMAIL, GIT_COMMIT_AUTHOR_NAME, GIT_COMMIT_COMMITTER_DATE, GIT_COMMIT_COMMITTER_EMAIL, GIT_COMMIT_COMMITTER_NAME, GIT_COMMIT_MESSAGE, GIT_REPOSITORY_URL, GIT_SHA, GIT_TAG } from './tags';
 export interface Metadata {
     ci: {
+        job: {
+            name?: string;
+            url?: string;
+        };
         pipeline: {
+            id?: string;
+            name?: string;
+            number?: number;
             url?: string;
         };
         provider: {
-            name: string;
+            name?: string;
         };
+        stage: {
+            name?: string;
+        };
+        workspace_path?: string;
     };
     git: {
         branch?: string;
-        commitSha?: string;
+        commit: {
+            author: {
+                date?: string;
+                email?: string;
+                name?: string;
+            };
+            committer: {
+                date?: string;
+                email?: string;
+                name?: string;
+            };
+            message?: string;
+            sha?: string;
+        };
+        repository_url?: string;
+        tag?: string;
     };
 }
 export declare type SpanTag = typeof CI_JOB_NAME | typeof CI_JOB_URL | typeof CI_PIPELINE_ID | typeof CI_PIPELINE_NAME | typeof CI_PIPELINE_NUMBER | typeof CI_PIPELINE_URL | typeof CI_PROVIDER_NAME | typeof CI_STAGE_NAME | typeof CI_WORKSPACE_PATH | typeof GIT_BRANCH | typeof GIT_REPOSITORY_URL | typeof GIT_SHA | typeof GIT_TAG | typeof GIT_COMMIT_AUTHOR_EMAIL | typeof GIT_COMMIT_AUTHOR_NAME | typeof GIT_COMMIT_AUTHOR_DATE | typeof GIT_COMMIT_MESSAGE | typeof GIT_COMMIT_COMMITTER_DATE | typeof GIT_COMMIT_COMMITTER_EMAIL | typeof GIT_COMMIT_COMMITTER_NAME;

package/dist/helpers/user-provided-git.js

@@ -5,11 +5,20 @@ const tags_1 = require("./tags");
 const utils_1 = require("./utils");
 const getUserGitMetadata = () => {
     const { DD_GIT_REPOSITORY_URL, DD_GIT_COMMIT_SHA, DD_GIT_BRANCH, DD_GIT_TAG, DD_GIT_COMMIT_MESSAGE, DD_GIT_COMMIT_AUTHOR_NAME, DD_GIT_COMMIT_AUTHOR_EMAIL, DD_GIT_COMMIT_AUTHOR_DATE, DD_GIT_COMMIT_COMMITTER_NAME, DD_GIT_COMMIT_COMMITTER_EMAIL, DD_GIT_COMMIT_COMMITTER_DATE, } = process.env;
+    let branch = utils_1.normalizeRef(DD_GIT_BRANCH);
+    let tag = utils_1.normalizeRef(DD_GIT_TAG);
+    if (DD_GIT_TAG) {
+        branch = undefined;
+    }
+    if ((DD_GIT_BRANCH === null || DD_GIT_BRANCH === void 0 ? void 0 : DD_GIT_BRANCH.includes('origin/tags')) || (DD_GIT_BRANCH === null || DD_GIT_BRANCH === void 0 ? void 0 : DD_GIT_BRANCH.includes('refs/heads/tags'))) {
+        branch = undefined;
+        tag = utils_1.normalizeRef(DD_GIT_BRANCH);
+    }
     return utils_1.removeEmptyValues({
         [tags_1.GIT_REPOSITORY_URL]: DD_GIT_REPOSITORY_URL,
-        [tags_1.GIT_BRANCH]: DD_GIT_BRANCH,
+        [tags_1.GIT_BRANCH]: branch,
         [tags_1.GIT_SHA]: DD_GIT_COMMIT_SHA,
-        [tags_1.GIT_TAG]: DD_GIT_TAG,
+        [tags_1.GIT_TAG]: tag,
         [tags_1.GIT_COMMIT_MESSAGE]: DD_GIT_COMMIT_MESSAGE,
         [tags_1.GIT_COMMIT_COMMITTER_DATE]: DD_GIT_COMMIT_COMMITTER_DATE,
         [tags_1.GIT_COMMIT_COMMITTER_EMAIL]: DD_GIT_COMMIT_COMMITTER_EMAIL,

package/dist/helpers/utils.d.ts

@@ -28,4 +28,8 @@ export declare const getProxyAgent: (proxyOpts?: ProxyConfiguration | undefined)
 export declare const getApiHostForSite: (site: string) => string;
 export declare const buildPath: (...args: string[]) => string;
 export declare const removeEmptyValues: (tags: SpanTags) => {};
+export declare const removeUndefinedValues: <T extends {
+    [key: string]: any;
+}>(object: T) => T;
+export declare const normalizeRef: (ref: string | undefined) => string | undefined;
 export {};

package/dist/helpers/utils.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeEmptyValues = exports.buildPath = exports.getApiHostForSite = exports.getProxyAgent = exports.getRequestBuilder = exports.getProxyUrl = exports.parseConfigFile = exports.getConfig = exports.pick = void 0;
+exports.normalizeRef = exports.removeUndefinedValues = exports.removeEmptyValues = exports.buildPath = exports.getApiHostForSite = exports.getProxyAgent = exports.getRequestBuilder = exports.getProxyUrl = exports.parseConfigFile = exports.getConfig = exports.pick = void 0;
 const fs_1 = __importDefault(require("fs"));
 const util_1 = require("util");
 const axios_1 = __importDefault(require("axios"));
@@ -130,3 +130,20 @@ const removeEmptyValues = (tags) => Object.keys(tags).reduce((filteredTags, tag)
     return Object.assign(Object.assign({}, filteredTags), { [tag]: tags[tag] });
 }, {});
 exports.removeEmptyValues = removeEmptyValues;
+const removeUndefinedValues = (object) => {
+    const newObject = Object.assign({}, object);
+    for (const [key, value] of Object.entries(newObject)) {
+        if (value === undefined) {
+            delete newObject[key];
+        }
+    }
+    return newObject;
+};
+exports.removeUndefinedValues = removeUndefinedValues;
+const normalizeRef = (ref) => {
+    if (!ref) {
+        return ref;
+    }
+    return ref.replace(/origin\/|refs\/heads\/|tags\//gm, '');
+};
+exports.normalizeRef = normalizeRef;

package/dist/index.d.ts

@@ -1 +1,3 @@
-export {};
+import * as synthetics from './commands/synthetics';
+import * as utils from './helpers/utils';
+export { utils, synthetics };

package/dist/index.js

@@ -1,34 +1,26 @@
-#!/usr/bin/env node
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const clipanion_1 = require("clipanion");
-const onError = (err) => {
-    console.log(err);
-    process.exitCode = 1;
-};
-process.on('uncaughtException', onError);
-process.on('unhandledRejection', onError);
-const cli = new clipanion_1.Cli({
-    binaryLabel: 'Datadog CI',
-    binaryName: 'datadog-ci',
-    binaryVersion: require('../package.json').version,
-});
-const commandsPath = `${__dirname}/commands`;
-for (const commandFolder of fs_1.default.readdirSync(commandsPath)) {
-    const commandPath = `${commandsPath}/${commandFolder}`;
-    if (fs_1.default.statSync(commandPath).isDirectory()) {
-        // tslint:disable-next-line: no-var-requires
-        require(commandPath).forEach((command) => cli.register(command));
-    }
-}
-if (require.main === module) {
-    cli.runExit(process.argv.slice(2), {
-        stderr: process.stderr,
-        stdin: process.stdin,
-        stdout: process.stdout,
-    });
-}
+exports.synthetics = exports.utils = void 0;
+const synthetics = __importStar(require("./commands/synthetics"));
+exports.synthetics = synthetics;
+const utils = __importStar(require("./helpers/utils"));
+exports.utils = utils;