`gitlab` Submodule ¶

Structs ¶

PagesAsciiDoctorProps ¶

Initializer ¶

import { gitlab } from '@gcix/gcix'

const pagesAsciiDoctorProps: gitlab.PagesAsciiDoctorProps = { ... }

Properties ¶

Name	Type	Description
`outFile`	`string`	Output HTML file.
`source`	`string`	Source .adoc files to translate to HTML files.
`jobName`	`string`	The name of the job.
`jobStage`	`string`	The stage of the job.

`outFile`^Required ¶

public readonly outFile: string;

Type: string

Output HTML file.

`source`^Required ¶

public readonly source: string;

Type: string

Source .adoc files to translate to HTML files.

`jobName`^Optional ¶

public readonly jobName: string;

Type: string

The name of the job.

`jobStage`^Optional ¶

public readonly jobStage: string;

Type: string

The stage of the job.

Classes ¶

GitlabScripts ¶

GitlabScripts Class Documentation.

The GitlabScripts class provides utility methods for performing various Git-related actions in the context of GitLab.

Static Functions ¶

Name	Description
`cloneRepository`	Clones a repository from a remote Git server using the Git command.

`cloneRepository` ¶

import { gitlab } from '@gcix/gcix'

gitlab.GitlabScripts.cloneRepository(path: string, branch?: string)

Clones a repository from a remote Git server using the Git command.

`path`^Required ¶

Type: string

The path of the repository to clone.

Should start with a forward slash ("/").

`branch`^Optional ¶

Type: string

(Optional) The branch name to clone from the remote repository.

Currently, only "main" is supported.

PagesAsciiDoctor ¶

Implements: IPagesAsciiDoctor

Translate the AsciiDoc source FILE as Gitlab Pages HTML5 file.

Runs asciidoctor {source} -o public{out_file}and stores the output as artifact under the public directory.

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

name: asciidoctor-pages
stage: build
image: ruby:3-alpine
artifacts: Path 'public'

Initializers ¶

import { gitlab } from '@gcix/gcix'

new gitlab.PagesAsciiDoctor(props: PagesAsciiDoctorProps)

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

`props`^Required ¶

Type: PagesAsciiDoctorProps

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.
`outFile`	`string`	Output HTML file.
`source`	`string`	Source .adoc files to translate to HTML files.

`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}

`outFile`^Required ¶

public readonly outFile: string;

Type: string

Output HTML file.

`source`^Required ¶

public readonly source: string;

Type: string

Source .adoc files to translate to HTML files.

Protocols ¶

IPagesAsciiDoctor ¶

Implemented By: PagesAsciiDoctor, IPagesAsciiDoctor

Properties ¶

Name	Type	Description
`outFile`	`string`	Output HTML file.
`source`	`string`	Source .adoc files to translate to HTML files.

`outFile`^Required ¶

public readonly outFile: string;

Type: string

Output HTML file.

`source`^Required ¶

public readonly source: string;

Type: string

Source .adoc files to translate to HTML files.

gitlab Submodule ¶

Structs ¶

PagesAsciiDoctorProps ¶

Initializer ¶

Properties ¶

outFileRequired ¶

sourceRequired ¶

jobNameOptional ¶

jobStageOptional ¶

Classes ¶

GitlabScripts ¶

Static Functions ¶

cloneRepository ¶

pathRequired ¶

branchOptional ¶

PagesAsciiDoctor ¶

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 ¶

outFileRequired ¶

`gitlab` Submodule ¶

`outFile`^Required ¶

`source`^Required ¶

`jobName`^Optional ¶

`jobStage`^Optional ¶

`cloneRepository` ¶

`path`^Required ¶

`branch`^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 ¶

`outFile`^Required ¶

`source`^Required ¶

`outFile`^Required ¶

`source`^Required ¶