gitlab-ci-env/index.d.ts

Get built-in environment variables exposed by GitLab CI.

declare const _exports: Readonly<{
    chat: {
        channel: string | undefined;
        input: string | undefined;
        userID: string | undefined;
    };
    ci: {
        apiGraphqlUrl: string | undefined;
        apiV4Url: string | undefined;
        buildNetworkName: string | undefined;
        buildsDir: string | undefined;
        commit: {
            author: string | undefined;
            beforeSha: string | undefined;
            branch: string | undefined;
            defaultBranchBaseSha: string | undefined;
            description: string | undefined;
            message: string | undefined;
            messageIsTruncated: string | undefined;
            ref: {
                name: string | undefined;
                slug: string | undefined;
            };
            refProtected: string | undefined;
            sha: string | undefined;
            shortSha: string | undefined;
            tag: string | undefined;
            tagMessage: string | undefined;
            timestamp: string | undefined;
            title: string | undefined;
            userLogin: string | undefined;
        };
        concurrentID: string | undefined;
        concurrentProjectID: string | undefined;
        config: {
            path: string | undefined;
            refUri: string | undefined;
        };
        debug: {
            services: string | undefined;
            trace: string | undefined;
        };
        defaultBranch: string | undefined;
        defaultBranchSlug: string | undefined;
        dependencyProxy: {
            directGroupImagePrefix: string | undefined;
            groupImagePrefix: string | undefined;
            password: string | undefined;
            server: string | undefined;
            user: string | undefined;
        };
        deploy: {
            freeze: string | undefined;
            password: string | undefined;
            user: string | undefined;
        };
        environment: {
            action: string | undefined;
            id: string | undefined;
            isDisposable: string | undefined;
            name: string | undefined;
            slug: string | undefined;
            tier: string | undefined;
            url: string | undefined;
        };
        externalPullRequest: {
            iid: string | undefined;
            source: {
                branch: {
                    name: string | undefined;
                    sha: string | undefined;
                };
                repository: string | undefined;
            };
            target: {
                branch: {
                    name: string | undefined;
                    sha: string | undefined;
                };
                repository: string | undefined;
            };
        };
        hasOpenRequirements: string | undefined;
        isCI: string | undefined;
        job: {
            groupName: string | undefined;
            id: string | undefined;
            image: string | undefined;
            manual: string | undefined;
            name: string | undefined;
            nameSlug: string | undefined;
            stage: string | undefined;
            startedAt: string | undefined;
            startedAtSlug: string | undefined;
            status: string | undefined;
            timeout: string | undefined;
            token: string | undefined;
            traceparent: string | undefined;
            tracestate: string | undefined;
            url: string | undefined;
        };
        kubeConfig: string | undefined;
        kubernetesActive: string | undefined;
        mergeRequest: {
            approved: string | undefined;
            assignees: string | undefined;
            description: string | undefined;
            descriptionTruncated: string | undefined;
            diff: {
                baseSha: string | undefined;
                id: string | undefined;
            };
            draft: string | undefined;
            eventType: string | undefined;
            id: string | undefined;
            iid: string | undefined;
            labels: string | undefined;
            milestones: string | undefined;
            project: {
                id: string | undefined;
                path: string | undefined;
                url: string | undefined;
            };
            refPath: string | undefined;
            source: {
                branch: {
                    name: string | undefined;
                    protected: string | undefined;
                    sha: string | undefined;
                };
                project: {
                    id: string | undefined;
                    path: string | undefined;
                    url: string | undefined;
                };
            };
            squashOnMerge: string | undefined;
            target: {
                branch: {
                    name: string | undefined;
                    protected: string | undefined;
                    sha: string | undefined;
                };
            };
            title: string | undefined;
        };
        node: {
            index: string | undefined;
            total: string | undefined;
        };
        pages: {
            domain: string | undefined;
            hostname: string | undefined;
            url: string | undefined;
        };
        pipeline: {
            createdAt: string | undefined;
            id: string | undefined;
            iid: string | undefined;
            name: string | undefined;
            schedule: {
                description: string | undefined;
            };
            source: string | undefined;
            triggered: string | undefined;
            url: string | undefined;
        };
        project: {
            classificationLabel: string | undefined;
            description: string | undefined;
            dir: string | undefined;
            id: string | undefined;
            name: string | undefined;
            namespace: {
                fullPath: string | undefined;
                id: string | undefined;
                slug: string | undefined;
            };
            openMergeRequests: string | undefined;
            path: string | undefined;
            pathSlug: string | undefined;
            repositoryLanguages: string | undefined;
            rootNamespace: {
                name: string | undefined;
                slug: string | undefined;
            };
            title: string | undefined;
            topics: string | undefined;
            url: string | undefined;
            visibility: string | undefined;
        };
        registry: {
            image: string | undefined;
            password: string | undefined;
            registry: string | undefined;
            url: string | undefined;
            user: string | undefined;
        };
        release: {
            description: string | undefined;
        };
        runner: {
            description: string | undefined;
            executableArch: string | undefined;
            id: string | undefined;
            revision: string | undefined;
            shortToken: string | undefined;
            tags: string | undefined;
            version: string | undefined;
        };
        server: {
            fqdn: string | undefined;
            host: string | undefined;
            isServer: string | undefined;
            name: string | undefined;
            port: string | undefined;
            protocol: string | undefined;
            revision: string | undefined;
            ssh: {
                host: string | undefined;
                port: string | undefined;
            };
            tlsCaFile: string | undefined;
            tlsCertFile: string | undefined;
            tlsKeyFile: string | undefined;
            url: string | undefined;
            version: {
                major: string | undefined;
                minor: string | undefined;
                patch: string | undefined;
                version: string | undefined;
            };
        };
        sharedEnvironment: string | undefined;
        templateRegistryHost: string | undefined;
        trigger: {
            payload: string | undefined;
            shortToken: string | undefined;
        };
        upstream: {
            jobID: string | undefined;
            pipelineID: string | undefined;
            projectID: string | undefined;
        };
    };
    gitlab: {
        features: string | undefined;
        fipsMode: string | undefined;
        isCI: string | undefined;
        user: {
            email: string | undefined;
            id: string | undefined;
            login: string | undefined;
            name: string | undefined;
        };
    };
}>;
export = _exports;