`git` Submodule ¶

Structs ¶

GitMirrorProps ¶

Initializer ¶

import { git } from '@gcix/gcix'

const gitMirrorProps: git.GitMirrorProps = { ... }

Properties ¶

Name	Type	Description
`remoteRepository`	`string`	The git repository the code of the pipelines repository should be mirrored to.
`gitConfigUserEmail`	`string`	The 'user.email' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_EMAIL.
`gitConfigUserName`	`string`	The 'user.name' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_NAME.
`jobName`	`string`	The name of the Bootstrap job.
`jobStage`	`string`	The stage of the Bootstrap job.
`privateKeyVariable`	`string`	DO NOT PROVIDE YOUR PRIVATE SSH KEY HERE!!! This parameter takes the name of the Gitlab environment variable, which contains the private ssh key used to push to the remote repository. This one should be created as protected and masked variable in the 'CI/CD' settings of your project.
`runOnlyForRepositoryUrl`	`string`	When mirroring to a remote Gitlab instance, you don't want to run this mirroring job there again.
`scriptHook`	`string[]`	This list of strings could contain any commands that should be executed between pulling the current repository and pushing it to the remote.

`remoteRepository`^Required ¶

public readonly remoteRepository: string;

Type: string

The git repository the code of the pipelines repository should be mirrored to.

`gitConfigUserEmail`^Optional ¶

public readonly gitConfigUserEmail: string;

Type: string

The 'user.email' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_EMAIL.

`gitConfigUserName`^Optional ¶

public readonly gitConfigUserName: string;

Type: string

The 'user.name' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_NAME.

`jobName`^Optional ¶

public readonly jobName: string;

Type: string

The name of the Bootstrap job.

`jobStage`^Optional ¶

public readonly jobStage: string;

Type: string

The stage of the Bootstrap job.

`privateKeyVariable`^Optional ¶

public readonly privateKeyVariable: string;

Type: string

DO NOT PROVIDE YOUR PRIVATE SSH KEY HERE!!! This parameter takes the name of the Gitlab environment variable, which contains the private ssh key used to push to the remote repository. This one should be created as protected and masked variable in the 'CI/CD' settings of your project.

`runOnlyForRepositoryUrl`^Optional ¶

public readonly runOnlyForRepositoryUrl: string;

Type: string

When mirroring to a remote Gitlab instance, you don't want to run this mirroring job there again.

With this variable the job only runs, when its value matches the CI_REPOSITORY_URL of the current repository.

`scriptHook`^Optional ¶

public readonly scriptHook: string[];

Type: string[]

This list of strings could contain any commands that should be executed between pulling the current repository and pushing it to the remote.

This hook is mostly meant to be for git configuration commands, required to push to the remote repository.

Classes ¶

GitMirror ¶

Implements: IGitMirror

This job clones the CI_COMMIT_REF_NAME of the current repository and forcefully pushes this REF to the remote_repository.

This subclass of Job will configure following defaults for the superclass:

name: git-mirror
stage: deploy
image: PredefinedImages.ALPINE_GIT

Initializers ¶

import { git } from '@gcix/gcix'

new git.GitMirror(props: GitMirrorProps)

Name	Type	Description
`props`	`GitMirrorProps`	No description.

`props`^Required ¶

Type: GitMirrorProps

Methods ¶

Name	Description
`addDependencies`	No description.
`addNeeds`	No description.
`addParent`	This method is called by `gcix.JobCollection`s when the job is added to that JobCollection.
`addTags`	No description.
`addVariables`	No description.
`appendRules`	No description.
`appendScripts`	No description.
`assignAllowFailure`	No description.
`assignArtifacts`	No description.
`assignCache`	No description.
`assignDependencies`	No description.
`assignImage`	Sets the image of this job.
`assignNeeds`	No description.
`assignTags`	No description.
`copy`	Returns an independent, deep copy object of this job.
`extendName`	This method is used by `gcix.JobCollection`s to populate the jobs name.
`extendStage`	This method is used by `gcix.JobCollection`s to populate the jobs name and stage.
`extendStageValue`	This method is used by `gcix.JobCollection`s to populate the jobs stage.
`getAllInstanceNames`	Return all instance names from the given child.
`isEqual`	`isEqual` checks if `this` object is equal to given object.
`prependRules`	No description.
`prependScripts`	No description.
`render`	Returns a representation of any object which implements `IBase`.

`addDependencies` ¶

public addDependencies(dependencies: Job | JobCollection | Need[]): Job

`dependencies`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`addNeeds` ¶

public addNeeds(needs: Job | JobCollection | Need[]): Job

`needs`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`addParent` ¶

public addParent(parent: Job | JobCollection): void

This method is called by gcix.JobCollections when the job is added to that JobCollection.

The job needs to know its parents when getAllInstanceNames() is called.

`parent`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection

`addTags` ¶

public addTags(tags: string[]): Job

`tags`^Required ¶

Type: string[]

`addVariables` ¶

public addVariables(variables: {[ key: string ]: string}): Job

`variables`^Required ¶

Type: {[ key: string ]: string}

`appendRules` ¶

public appendRules(rules: Rule[]): Job

`rules`^Required ¶

Type: @gcix/gcix.Rule[]

`appendScripts` ¶

public appendScripts(scripts: string[]): Job

`scripts`^Required ¶

Type: string[]

`assignAllowFailure` ¶

public assignAllowFailure(allowFailure: boolean | number[]): Job

`allowFailure`^Required ¶

Type: boolean | number[]

`assignArtifacts` ¶

public assignArtifacts(artifacts: Artifacts): Job

`artifacts`^Required ¶

Type: @gcix/gcix.Artifacts

`assignCache` ¶

public assignCache(cache: Cache): Job

`cache`^Required ¶

Type: @gcix/gcix.Cache

`assignDependencies` ¶

public assignDependencies(dependencies: Job | JobCollection | Need[]): Job

`dependencies`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`assignImage` ¶

public assignImage(image: string | Image): Job

Sets the image of this job.

For a simple container image you can provide the origin of the image. If you want to set the entrypoint, you have to provide an Image object instead.

!! Any previous values will be overwritten.

`image`^Required ¶

Type: string | @gcix/gcix.Image

`assignNeeds` ¶

public assignNeeds(needs: Job | JobCollection | Need[]): Job

`needs`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`assignTags` ¶

public assignTags(tags: string[]): Job

`tags`^Required ¶

Type: string[]

`copy` ¶

public copy(): Job

Returns an independent, deep copy object of this job.

`extendName` ¶

public extendName(name: string): void

This method is used by gcix.JobCollections to populate the jobs name.

`name`^Required ¶

Type: string

`extendStage` ¶

public extendStage(stage: string): void

This method is used by gcix.JobCollections to populate the jobs name and stage.

`stage`^Required ¶

Type: string

`extendStageValue` ¶

public extendStageValue(stage: string): void

This method is used by gcix.JobCollections to populate the jobs stage.

`stage`^Required ¶

Type: string

`getAllInstanceNames` ¶

public getAllInstanceNames(child?: Job | JobCollection): OrderedStringSet

Return all instance names from the given child.

That means all combinations of the childs name and stage within this sequence and all parent sequences.

`child`^Optional ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection

`isEqual` ¶

public isEqual(comparable: IBase): boolean

isEqual checks if this object is equal to given object.

`comparable`^Required ¶

Type: @gcix/gcix.IBase

`prependRules` ¶

public prependRules(rules: Rule[]): Job

`rules`^Required ¶

Type: @gcix/gcix.Rule[]

`prependScripts` ¶

public prependScripts(scripts: string[]): Job

`scripts`^Required ¶

Type: string[]

`render` ¶

public render(): any

Returns a representation of any object which implements IBase.

The rendered representation is used by the gcix to dump it in YAML format as part of the .gitlab-ci.yml pipeline.

Properties ¶

Name	Type	Description
`tags`	`string[]`	Getter method to receive added tags.
`allowFailure`	`string \| boolean \| number[]`	No description.
`name`	`string`	No description.
`orderedTags`	`@gcix/gcix.OrderedStringSet`	No description.
`parents`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection[]`	No description.
`scripts`	`string[]`	No description.
`stage`	`string`	No description.
`artifacts`	`@gcix/gcix.Artifacts`	No description.
`cache`	`@gcix/gcix.Cache`	No description.
`dependencies`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection \| @gcix/gcix.Need[]`	No description.
`image`	`@gcix/gcix.Image`	No description.
`needs`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection \| @gcix/gcix.Need[]`	No description.
`original`	`@gcix/gcix.Job`	No description.
`rules`	`@gcix/gcix.Rule[]`	No description.
`variables`	`{[ key: string ]: string}`	No description.
`gitConfigUserEmail`	`string`	The 'user.email' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_EMAIL.
`gitConfigUserName`	`string`	The 'user.name' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_NAME.
`remoteRepository`	`string`	The git repository the code of the pipelines repository should be mirrored to.
`scriptHook`	`string[]`	This list of strings could contain any commands that should be executed between pulling the current repository and pushing it to the remote.
`privateKeyVariable`	`string`	DO NOT PROVIDE YOUR PRIVATE SSH KEY HERE!!! This parameter takes the name of the Gitlab environment variable, which contains the private ssh key used to push to the remote repository. This one should be created as protected and masked variable in the 'CI/CD' settings of your project.
`runOnlyForRepositoryUrl`	`string`	When mirroring to a remote Gitlab instance, you don't want to run this mirroring job there again.

`tags`^Required ¶

public readonly tags: string[];

Type: string[]

Getter method to receive added tags.

`allowFailure`^Required ¶

public readonly allowFailure: string | boolean | number[];

Type: string | boolean | number[]

`name`^Required ¶

public readonly name: string;

Type: string

`orderedTags`^Required ¶

public readonly orderedTags: OrderedStringSet;

Type: @gcix/gcix.OrderedStringSet

`parents`^Required ¶

public readonly parents: Job | JobCollection[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection[]

`scripts`^Required ¶

public readonly scripts: string[];

Type: string[]

`stage`^Required ¶

public readonly stage: string;

Type: string

`artifacts`^Optional ¶

public readonly artifacts: Artifacts;

Type: @gcix/gcix.Artifacts

`cache`^Optional ¶

public readonly cache: Cache;

Type: @gcix/gcix.Cache

`dependencies`^Optional ¶

public readonly dependencies: Job | JobCollection | Need[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`image`^Optional ¶

public readonly image: Image;

Type: @gcix/gcix.Image

`needs`^Optional ¶

public readonly needs: Job | JobCollection | Need[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`original`^Optional ¶

public readonly original: Job;

Type: @gcix/gcix.Job

`rules`^Optional ¶

public readonly rules: Rule[];

Type: @gcix/gcix.Rule[]

`variables`^Optional ¶

public readonly variables: {[ key: string ]: string};

Type: {[ key: string ]: string}

`gitConfigUserEmail`^Required ¶

public readonly gitConfigUserEmail: string;

Type: string

The 'user.email' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_EMAIL.

`gitConfigUserName`^Required ¶

public readonly gitConfigUserName: string;

Type: string

The 'user.name' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_NAME.

`remoteRepository`^Required ¶

public readonly remoteRepository: string;

Type: string

The git repository the code of the pipelines repository should be mirrored to.

`scriptHook`^Required ¶

public readonly scriptHook: string[];

Type: string[]

This list of strings could contain any commands that should be executed between pulling the current repository and pushing it to the remote.

This hook is mostly meant to be for git configuration commands, required to push to the remote repository.

`privateKeyVariable`^Optional ¶

public readonly privateKeyVariable: string;

Type: string

DO NOT PROVIDE YOUR PRIVATE SSH KEY HERE!!! This parameter takes the name of the Gitlab environment variable, which contains the private ssh key used to push to the remote repository. This one should be created as protected and masked variable in the 'CI/CD' settings of your project.

`runOnlyForRepositoryUrl`^Optional ¶

public readonly runOnlyForRepositoryUrl: string;

Type: string

When mirroring to a remote Gitlab instance, you don't want to run this mirroring job there again.

With this variable the job only runs, when its value matches the CI_REPOSITORY_URL of the current repository.

Protocols ¶

IGitMirror ¶

Implemented By: @gcix/gcix.aws.CdkMirrorToCodecommit, GitMirror, @gcix/gcix.aws.ICdkMirrorToCodecommit, IGitMirror

Properties ¶

Name	Type	Description
`gitConfigUserEmail`	`string`	The 'user.email' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_EMAIL.
`gitConfigUserName`	`string`	The 'user.name' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_NAME.
`remoteRepository`	`string`	The git repository the code of the pipelines repository should be mirrored to.
`scriptHook`	`string[]`	This list of strings could contain any commands that should be executed between pulling the current repository and pushing it to the remote.
`privateKeyVariable`	`string`	DO NOT PROVIDE YOUR PRIVATE SSH KEY HERE!!! This parameter takes the name of the Gitlab environment variable, which contains the private ssh key used to push to the remote repository. This one should be created as protected and masked variable in the 'CI/CD' settings of your project.
`runOnlyForRepositoryUrl`	`string`	When mirroring to a remote Gitlab instance, you don't want to run this mirroring job there again.

`gitConfigUserEmail`^Required ¶

public readonly gitConfigUserEmail: string;

Type: string

The 'user.email' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_EMAIL.

`gitConfigUserName`^Required ¶

public readonly gitConfigUserName: string;

Type: string

The 'user.name' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_NAME.

`remoteRepository`^Required ¶

public readonly remoteRepository: string;

Type: string

The git repository the code of the pipelines repository should be mirrored to.

`scriptHook`^Required ¶

public readonly scriptHook: string[];

Type: string[]

This list of strings could contain any commands that should be executed between pulling the current repository and pushing it to the remote.

This hook is mostly meant to be for git configuration commands, required to push to the remote repository.

`privateKeyVariable`^Optional ¶

public readonly privateKeyVariable: string;

Type: string

DO NOT PROVIDE YOUR PRIVATE SSH KEY HERE!!! This parameter takes the name of the Gitlab environment variable, which contains the private ssh key used to push to the remote repository. This one should be created as protected and masked variable in the 'CI/CD' settings of your project.

`runOnlyForRepositoryUrl`^Optional ¶

public readonly runOnlyForRepositoryUrl: string;

Type: string

When mirroring to a remote Gitlab instance, you don't want to run this mirroring job there again.

With this variable the job only runs, when its value matches the CI_REPOSITORY_URL of the current repository.

git Submodule ¶

Structs ¶

GitMirrorProps ¶

Initializer ¶

Properties ¶

remoteRepositoryRequired ¶

gitConfigUserEmailOptional ¶

gitConfigUserNameOptional ¶

jobNameOptional ¶

jobStageOptional ¶

privateKeyVariableOptional ¶

runOnlyForRepositoryUrlOptional ¶

scriptHookOptional ¶

Classes ¶

GitMirror ¶

Initializers ¶

propsRequired ¶

Methods ¶

addDependencies ¶

dependenciesRequired ¶

addNeeds ¶

needsRequired ¶

addParent ¶

parentRequired ¶

addTags ¶

tagsRequired ¶

addVariables ¶

variablesRequired ¶

appendRules ¶

rulesRequired ¶

appendScripts ¶

scriptsRequired ¶

assignAllowFailure ¶

allowFailureRequired ¶

assignArtifacts ¶

artifactsRequired ¶

assignCache ¶

cacheRequired ¶

assignDependencies ¶

dependenciesRequired ¶

assignImage ¶

imageRequired ¶

assignNeeds ¶

needsRequired ¶

assignTags ¶

tagsRequired ¶

copy ¶

extendName ¶

nameRequired ¶

extendStage ¶

stageRequired ¶

extendStageValue ¶

stageRequired ¶

getAllInstanceNames ¶

childOptional ¶

isEqual ¶

comparableRequired ¶

prependRules ¶

rulesRequired ¶

prependScripts ¶

scriptsRequired ¶

render ¶

Properties ¶

tagsRequired ¶

allowFailureRequired ¶

nameRequired ¶

orderedTagsRequired ¶

parentsRequired ¶

scriptsRequired ¶

stageRequired ¶

artifactsOptional ¶

cacheOptional ¶

dependenciesOptional ¶

imageOptional ¶

needsOptional ¶

originalOptional ¶

rulesOptional ¶

variablesOptional ¶

gitConfigUserEmailRequired ¶

gitConfigUserNameRequired ¶

`git` Submodule ¶

`remoteRepository`^Required ¶

`gitConfigUserEmail`^Optional ¶

`gitConfigUserName`^Optional ¶

`jobName`^Optional ¶

`jobStage`^Optional ¶

`privateKeyVariable`^Optional ¶

`runOnlyForRepositoryUrl`^Optional ¶

`scriptHook`^Optional ¶

`props`^Required ¶

`addDependencies` ¶

`dependencies`^Required ¶

`addNeeds` ¶

`needs`^Required ¶

`addParent` ¶

`parent`^Required ¶

`addTags` ¶

`tags`^Required ¶

`addVariables` ¶

`variables`^Required ¶

`appendRules` ¶

`rules`^Required ¶

`appendScripts` ¶

`scripts`^Required ¶

`assignAllowFailure` ¶

`allowFailure`^Required ¶

`assignArtifacts` ¶

`artifacts`^Required ¶

`assignCache` ¶

`cache`^Required ¶

`assignDependencies` ¶

`dependencies`^Required ¶

`assignImage` ¶

`image`^Required ¶

`assignNeeds` ¶

`needs`^Required ¶

`assignTags` ¶

`tags`^Required ¶

`copy` ¶

`extendName` ¶

`name`^Required ¶

`extendStage` ¶

`stage`^Required ¶

`extendStageValue` ¶

`stage`^Required ¶

`getAllInstanceNames` ¶

`child`^Optional ¶

`isEqual` ¶

`comparable`^Required ¶

`prependRules` ¶

`rules`^Required ¶

`prependScripts` ¶

`scripts`^Required ¶

`render` ¶

`tags`^Required ¶

`allowFailure`^Required ¶

`name`^Required ¶

`orderedTags`^Required ¶

`parents`^Required ¶

`scripts`^Required ¶

`stage`^Required ¶

`artifacts`^Optional ¶

`cache`^Optional ¶

`dependencies`^Optional ¶

`image`^Optional ¶

`needs`^Optional ¶

`original`^Optional ¶

`rules`^Optional ¶

`variables`^Optional ¶

`gitConfigUserEmail`^Required ¶

`gitConfigUserName`^Required ¶

`remoteRepository`^Required ¶

`scriptHook`^Required ¶

`privateKeyVariable`^Optional ¶

`runOnlyForRepositoryUrl`^Optional ¶

`gitConfigUserEmail`^Required ¶

`gitConfigUserName`^Required ¶

`remoteRepository`^Required ¶

`scriptHook`^Required ¶

`privateKeyVariable`^Optional ¶