Skip to content

python Submodule

Structs

PagesPdoc3Props

Initializer 

1
2
3
import { python } from '@gcix/gcix'

const pagesPdoc3Props: python.PagesPdoc3Props = { ... }

Properties

Name Type Description
module string The Python module name.
jobName string The name of the job.
jobStage string The stage of the job.
outputPath string A sub path of the Gitlab Pages public directory to output generated HTML/markdown files to.
moduleRequired 
1
public readonly module: string;
  • Type: string

The Python module name.

This may be an import path resolvable in the current environment, or a file path to a Python module or package.

jobNameOptional 
1
public readonly jobName: string;
  • Type: string

The name of the job.

jobStageOptional 
1
public readonly jobStage: string;
  • Type: string

The stage of the job.

outputPathOptional 
1
public readonly outputPath: string;
  • Type: string

A sub path of the Gitlab Pages public directory to output generated HTML/markdown files to.

Defaults to "/".

PagesSphinxProps

Initializer 

1
2
3
import { python } from '@gcix/gcix'

const pagesSphinxProps: python.PagesSphinxProps = { ... }

Properties

Name Type Description
jobName string The name of the job.
jobStage string The stage of the job.
pip PipInstallRequirementsProps No description.
jobNameOptional 
1
public readonly jobName: string;
  • Type: string

The name of the job.

jobStageOptional 
1
public readonly jobStage: string;
  • Type: string

The stage of the job.

pipOptional 
1
public readonly pip: PipInstallRequirementsProps;

PipInstallRequirementsProps

Represents the properties for the pipInstallRequirements static method.

Initializer 

1
2
3
import { python } from '@gcix/gcix'

const pipInstallRequirementsProps: python.PipInstallRequirementsProps = { ... }

Properties

Name Type Description
pipenvVersionSpecifier string The version hint of pipenv to install if Pipfile.lock is found. For example '==2022.08.15'. Defaults to an empty string, indicating installation of the latest version.
requirementsFile string The location and name of the requirements file.
pipenvVersionSpecifierOptional 
1
public readonly pipenvVersionSpecifier: string;
  • Type: string
  • Default: ""

The version hint of pipenv to install if Pipfile.lock is found. For example '==2022.08.15'. Defaults to an empty string, indicating installation of the latest version.

requirementsFileOptional 
1
public readonly requirementsFile: string;
  • Type: string
  • Default: "requirements.txt"

The location and name of the requirements file.

PythonBuildBdistWheelProps

Initializer 

1
2
3
import { python } from '@gcix/gcix'

const pythonBuildBdistWheelProps: python.PythonBuildBdistWheelProps = { ... }

Properties

Name Type Description
jobName string No description.
jobStage string No description.
pipRequirements PipInstallRequirementsProps No description.
jobNameOptional 
1
public readonly jobName: string;
  • Type: string
jobStageOptional 
1
public readonly jobStage: string;
  • Type: string
pipRequirementsOptional 
1
public readonly pipRequirements: PipInstallRequirementsProps;

PythonDeployTwineUploadProps

Represents the properties for the TwineUpload class.

Initializer 

1
2
3
import { python } from '@gcix/gcix'

const pythonDeployTwineUploadProps: python.PythonDeployTwineUploadProps = { ... }

Properties

Name Type Description
jobName string The name of the job.
jobStage string The stage of the job.
twinePasswordEnvVar string The name of the environment variable containing the password.
twineRepositoryUrl string The URL to the PyPI repository to which the Python artifacts will be deployed.
twineUsernameEnvVar string The name of the environment variable containing the username value.
jobNameOptional 
1
public readonly jobName: string;
  • Type: string

The name of the job.

jobStageOptional 
1
public readonly jobStage: string;
  • Type: string

The stage of the job.

twinePasswordEnvVarOptional 
1
public readonly twinePasswordEnvVar: string;
  • Type: string

The name of the environment variable containing the password.

DO NOT PROVIDE THE LOGIN VALUE ITSELF! This would be a security issue! Defaults to 'TWINE_PASSWORD'.

twineRepositoryUrlOptional 
1
public readonly twineRepositoryUrl: string;
  • Type: string

The URL to the PyPI repository to which the Python artifacts will be deployed.

If undefined the package is published to https://pypi.org.

twineUsernameEnvVarOptional 
1
public readonly twineUsernameEnvVar: string;
  • Type: string

The name of the environment variable containing the username value.

DO NOT PROVIDE THE USERNAME VALUE ITSELF! This would be a security issue! Defaults to 'TWINE_USERNAME'.

PythonFullStackProps

Initializer 

1
2
3
import { python } from '@gcix/gcix'

const pythonFullStackProps: python.PythonFullStackProps = { ... }

Properties

Name Type Description
twineProdJobProps PythonDeployTwineUploadProps No description.
bDistWheelJobProps PythonBuildBdistWheelProps No description.
evaluateGitTagPep440ConformityJobProps PythonTestEvaluateGitTagPep440ConformityProps No description.
flake8JobProps PythonLintFlake8Props No description.
isortJobProps PythonLintIsortProps No description.
mypyJobProps PythonLintMyPyProps No description.
pytestJobProps PythonTestPytestProps No description.
sphinxPropsJobProps PagesSphinxProps No description.
twineDevJobProps PythonDeployTwineUploadProps No description.
twineProdJobPropsRequired 
1
public readonly twineProdJobProps: PythonDeployTwineUploadProps;
bDistWheelJobPropsOptional 
1
public readonly bDistWheelJobProps: PythonBuildBdistWheelProps;
evaluateGitTagPep440ConformityJobPropsOptional 
1
public readonly evaluateGitTagPep440ConformityJobProps: PythonTestEvaluateGitTagPep440ConformityProps;
flake8JobPropsOptional 
1
public readonly flake8JobProps: PythonLintFlake8Props;
isortJobPropsOptional 
1
public readonly isortJobProps: PythonLintIsortProps;
mypyJobPropsOptional 
1
public readonly mypyJobProps: PythonLintMyPyProps;
pytestJobPropsOptional 
1
public readonly pytestJobProps: PythonTestPytestProps;
sphinxPropsJobPropsOptional 
1
public readonly sphinxPropsJobProps: PagesSphinxProps;
twineDevJobPropsOptional 
1
public readonly twineDevJobProps: PythonDeployTwineUploadProps;

PythonLintFlake8Props

Initializer 

1
2
3
import { python } from '@gcix/gcix'

const pythonLintFlake8Props: python.PythonLintFlake8Props = { ... }

Properties

Name Type Description
jobName string The name of the job.
jobStage string The stage of the job.
jobNameOptional 
1
public readonly jobName: string;
  • Type: string

The name of the job.

jobStageOptional 
1
public readonly jobStage: string;
  • Type: string

The stage of the job.

PythonLintIsortProps

Initializer 

1
2
3
import { python } from '@gcix/gcix'

const pythonLintIsortProps: python.PythonLintIsortProps = { ... }

Properties

Name Type Description
jobName string The name of the job.
jobStage string The stage of the job.
jobNameOptional 
1
public readonly jobName: string;
  • Type: string

The name of the job.

jobStageOptional 
1
public readonly jobStage: string;
  • Type: string

The stage of the job.

PythonLintMyPyProps

Initializer 

1
2
3
import { python } from '@gcix/gcix'

const pythonLintMyPyProps: python.PythonLintMyPyProps = { ... }

Properties

Name Type Description
packageDir string Package directory to type check.
jobName string The name of the job.
jobStage string The stage of the job.
myPyOptions string Adds arguments to mypy execution.
myPyVersion string If mypy is not already installed, this version will be installed.
packageDirRequired 
1
public readonly packageDir: string;
  • Type: string

Package directory to type check.

jobNameOptional 
1
public readonly jobName: string;
  • Type: string

The name of the job.

jobStageOptional 
1
public readonly jobStage: string;
  • Type: string

The stage of the job.

myPyOptionsOptional 
1
public readonly myPyOptions: string;
  • Type: string

Adds arguments to mypy execution.

myPyVersionOptional 
1
public readonly myPyVersion: string;
  • Type: string

If mypy is not already installed, this version will be installed.

Installs latest version if undefined.

PythonTestEvaluateGitTagPep440ConformityProps

Initializer 

1
2
3
import { python } from '@gcix/gcix'

const pythonTestEvaluateGitTagPep440ConformityProps: python.PythonTestEvaluateGitTagPep440ConformityProps = { ... }

Properties

Name Type Description
jobName string The name of the Bootstrap job.
jobStage string The stage of the Bootstrap job.
jobNameOptional 
1
public readonly jobName: string;
  • Type: string

The name of the Bootstrap job.

jobStageOptional 
1
public readonly jobStage: string;
  • Type: string

The stage of the Bootstrap job.

PythonTestPytestProps

Initializer 

1
2
3
import { python } from '@gcix/gcix'

const pythonTestPytestProps: python.PythonTestPytestProps = { ... }

Properties

Name Type Description
jobName string The name of the Bootstrap job.
jobStage string The stage of the Bootstrap job.
pipenvVersionSpecifier string The version hint of pipenv to install if Pipfile.lock is found. For example '==2022.08.15'. Defaults to latest package version.
pytestCommand string This argument is only required if you have a custom command to call pytest.
jobNameOptional 
1
public readonly jobName: string;
  • Type: string

The name of the Bootstrap job.

jobStageOptional 
1
public readonly jobStage: string;
  • Type: string

The stage of the Bootstrap job.

pipenvVersionSpecifierOptional 
1
public readonly pipenvVersionSpecifier: string;
  • Type: string

The version hint of pipenv to install if Pipfile.lock is found. For example '==2022.08.15'. Defaults to latest package version.

pytestCommandOptional 
1
public readonly pytestCommand: string;
  • Type: string

This argument is only required if you have a custom command to call pytest.

Classes

PagesPdoc3

Generate a HTML API documentation of you python code as Gitlab Pages.

Runs pdoc3 --html -f --skip-errors --output-dir public{path} {module} and stores the output as artifact under the public directory.

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

  • name: pdoc3-pages
  • stage: build
  • artifacts: Path 'public'

Initializers 

1
2
3
import { python } from '@gcix/gcix'

new python.PagesPdoc3(props: PagesPdoc3Props)
Name Type Description
props PagesPdoc3Props No description.
propsRequired

Methods

Name Description
addDependencies No description.
addNeeds No description.
addParent This method is called by gcix.JobCollections 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.JobCollections to populate the jobs name.
extendStage This method is used by gcix.JobCollections to populate the jobs name and stage.
extendStageValue This method is used by gcix.JobCollections 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 
1
public addDependencies(dependencies: Job | JobCollection | Need[]): Job
dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addNeeds 
1
public addNeeds(needs: Job | JobCollection | Need[]): Job
needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addParent 
1
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.

parentRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection
addTags 
1
public addTags(tags: string[]): Job
tagsRequired
  • Type: string[]
addVariables 
1
public addVariables(variables: {[ key: string ]: string}): Job
variablesRequired
  • Type: {[ key: string ]: string}
appendRules 
1
public appendRules(rules: Rule[]): Job
rulesRequired
  • Type: @gcix/gcix.Rule[]
appendScripts 
1
public appendScripts(scripts: string[]): Job
scriptsRequired
  • Type: string[]
assignAllowFailure 
1
public assignAllowFailure(allowFailure: boolean | number[]): Job
allowFailureRequired
  • Type: boolean | number[]
assignArtifacts 
1
public assignArtifacts(artifacts: Artifacts): Job
artifactsRequired
  • Type: @gcix/gcix.Artifacts
assignCache 
1
public assignCache(cache: Cache): Job
cacheRequired
  • Type: @gcix/gcix.Cache
assignDependencies 
1
public assignDependencies(dependencies: Job | JobCollection | Need[]): Job
dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
assignImage 
1
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.

imageRequired
  • Type: string | @gcix/gcix.Image
assignNeeds 
1
public assignNeeds(needs: Job | JobCollection | Need[]): Job
needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
assignTags 
1
public assignTags(tags: string[]): Job
tagsRequired
  • Type: string[]
copy 
1
public copy(): Job

Returns an independent, deep copy object of this job.

extendName 
1
public extendName(name: string): void

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

nameRequired
  • Type: string
extendStage 
1
public extendStage(stage: string): void

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

stageRequired
  • Type: string
extendStageValue 
1
public extendStageValue(stage: string): void

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

stageRequired
  • Type: string
getAllInstanceNames 
1
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.

childOptional
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection
isEqual 
1
public isEqual(comparable: IBase): boolean

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: @gcix/gcix.IBase
prependRules 
1
public prependRules(rules: Rule[]): Job
rulesRequired
  • Type: @gcix/gcix.Rule[]
prependScripts 
1
public prependScripts(scripts: string[]): Job
scriptsRequired
  • Type: string[]
render 
1
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.
module string The Python module name.
outputPath string A sub path of the Gitlab Pages public directory to output generated HTML/markdown files to.
tagsRequired 
1
public readonly tags: string[];
  • Type: string[]

Getter method to receive added tags.

allowFailureRequired 
1
public readonly allowFailure: string | boolean | number[];
  • Type: string | boolean | number[]
nameRequired 
1
public readonly name: string;
  • Type: string
orderedTagsRequired 
1
public readonly orderedTags: OrderedStringSet;
  • Type: @gcix/gcix.OrderedStringSet
parentsRequired 
1
public readonly parents: Job | JobCollection[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection[]
scriptsRequired 
1
public readonly scripts: string[];
  • Type: string[]
stageRequired 
1
public readonly stage: string;
  • Type: string
artifactsOptional 
1
public readonly artifacts: Artifacts;
  • Type: @gcix/gcix.Artifacts
cacheOptional 
1
public readonly cache: Cache;
  • Type: @gcix/gcix.Cache
dependenciesOptional 
1
public readonly dependencies: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
imageOptional 
1
public readonly image: Image;
  • Type: @gcix/gcix.Image
needsOptional 
1
public readonly needs: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
originalOptional 
1
public readonly original: Job;
  • Type: @gcix/gcix.Job
rulesOptional 
1
public readonly rules: Rule[];
  • Type: @gcix/gcix.Rule[]
variablesOptional 
1
public readonly variables: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
moduleRequired 
1
public readonly module: string;
  • Type: string

The Python module name.

This may be an import path resolvable in the current environment, or a file path to a Python module or package.

outputPathRequired 
1
public readonly outputPath: string;
  • Type: string

A sub path of the Gitlab Pages public directory to output generated HTML/markdown files to.

Defaults to "/".

PagesSphinx

Runs sphinx-build -b html -E -a docs public/${CI_COMMIT_REF_NAME} and installs project requirements. Uses: (PythonScripts.PipInstallRequirements()).

Requires a docs/requirements.txt in your project foldercontaining at leastsphinx- Creates artifacts for Gitlab Pages underpages`

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

  • name: sphinx-pages
  • stage: build
  • artifacts: Path 'public'

Initializers 

1
2
3
import { python } from '@gcix/gcix'

new python.PagesSphinx(props: PagesSphinxProps)
Name Type Description
props PagesSphinxProps No description.
propsRequired

Methods

Name Description
addDependencies No description.
addNeeds No description.
addParent This method is called by gcix.JobCollections 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.JobCollections to populate the jobs name.
extendStage This method is used by gcix.JobCollections to populate the jobs name and stage.
extendStageValue This method is used by gcix.JobCollections 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 
1
public addDependencies(dependencies: Job | JobCollection | Need[]): Job
dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addNeeds 
1
public addNeeds(needs: Job | JobCollection | Need[]): Job
needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addParent 
1
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.

parentRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection
addTags 
1
public addTags(tags: string[]): Job
tagsRequired
  • Type: string[]
addVariables 
1
public addVariables(variables: {[ key: string ]: string}): Job
variablesRequired
  • Type: {[ key: string ]: string}
appendRules 
1
public appendRules(rules: Rule[]): Job
rulesRequired
  • Type: @gcix/gcix.Rule[]
appendScripts 
1
public appendScripts(scripts: string[]): Job
scriptsRequired
  • Type: string[]
assignAllowFailure 
1
public assignAllowFailure(allowFailure: boolean | number[]): Job
allowFailureRequired
  • Type: boolean | number[]
assignArtifacts 
1
public assignArtifacts(artifacts: Artifacts): Job
artifactsRequired
  • Type: @gcix/gcix.Artifacts
assignCache 
1
public assignCache(cache: Cache): Job
cacheRequired
  • Type: @gcix/gcix.Cache
assignDependencies 
1
public assignDependencies(dependencies: Job | JobCollection | Need[]): Job
dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
assignImage 
1
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.

imageRequired
  • Type: string | @gcix/gcix.Image
assignNeeds 
1
public assignNeeds(needs: Job | JobCollection | Need[]): Job
needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
assignTags 
1
public assignTags(tags: string[]): Job
tagsRequired
  • Type: string[]
copy 
1
public copy(): Job

Returns an independent, deep copy object of this job.

extendName 
1
public extendName(name: string): void

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

nameRequired
  • Type: string
extendStage 
1
public extendStage(stage: string): void

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

stageRequired
  • Type: string
extendStageValue 
1
public extendStageValue(stage: string): void

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

stageRequired
  • Type: string
getAllInstanceNames 
1
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.

childOptional
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection
isEqual 
1
public isEqual(comparable: IBase): boolean

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: @gcix/gcix.IBase
prependRules 
1
public prependRules(rules: Rule[]): Job
rulesRequired
  • Type: @gcix/gcix.Rule[]
prependScripts 
1
public prependScripts(scripts: string[]): Job
scriptsRequired
  • Type: string[]
render 
1
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.
pip PipInstallRequirementsProps No description.
tagsRequired 
1
public readonly tags: string[];
  • Type: string[]

Getter method to receive added tags.

allowFailureRequired 
1
public readonly allowFailure: string | boolean | number[];
  • Type: string | boolean | number[]
nameRequired 
1
public readonly name: string;
  • Type: string
orderedTagsRequired 
1
public readonly orderedTags: OrderedStringSet;
  • Type: @gcix/gcix.OrderedStringSet
parentsRequired 
1
public readonly parents: Job | JobCollection[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection[]
scriptsRequired 
1
public readonly scripts: string[];
  • Type: string[]
stageRequired 
1
public readonly stage: string;
  • Type: string
artifactsOptional 
1
public readonly artifacts: Artifacts;
  • Type: @gcix/gcix.Artifacts
cacheOptional 
1
public readonly cache: Cache;
  • Type: @gcix/gcix.Cache
dependenciesOptional 
1
public readonly dependencies: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
imageOptional 
1
public readonly image: Image;
  • Type: @gcix/gcix.Image
needsOptional 
1
public readonly needs: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
originalOptional 
1
public readonly original: Job;
  • Type: @gcix/gcix.Job
rulesOptional 
1
public readonly rules: Rule[];
  • Type: @gcix/gcix.Rule[]
variablesOptional 
1
public readonly variables: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
pipOptional 
1
public readonly pip: PipInstallRequirementsProps;

PythonBuildBdistWheel

Runs python3 setup.py bdist_wheel and installs project requirements Requirements are installed by LinuxScripts.pipInstallRequirements().

This subclass of Job configures the following defaults for the superclass: - name: bdist_wheel - stage: build - artifacts: Path 'dist/'

Requires a Pipfile.lock or requirements.txt in your project folder containing at least setuptools. Creates artifacts under the path 'dist/'.

Initializers 

1
2
3
import { python } from '@gcix/gcix'

new python.PythonBuildBdistWheel(props: PythonBuildBdistWheelProps)
Name Type Description
props PythonBuildBdistWheelProps No description.
propsRequired

Methods

Name Description
addDependencies No description.
addNeeds No description.
addParent This method is called by gcix.JobCollections 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.JobCollections to populate the jobs name.
extendStage This method is used by gcix.JobCollections to populate the jobs name and stage.
extendStageValue This method is used by gcix.JobCollections 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 
1
public addDependencies(dependencies: Job | JobCollection | Need[]): Job
dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addNeeds 
1
public addNeeds(needs: Job | JobCollection | Need[]): Job
needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addParent 
1
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.

parentRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection
addTags 
1
public addTags(tags: string[]): Job
tagsRequired
  • Type: string[]
addVariables 
1
public addVariables(variables: {[ key: string ]: string}): Job
variablesRequired
  • Type: {[ key: string ]: string}
appendRules 
1
public appendRules(rules: Rule[]): Job
rulesRequired
  • Type: @gcix/gcix.Rule[]
appendScripts 
1
public appendScripts(scripts: string[]): Job
scriptsRequired
  • Type: string[]
assignAllowFailure 
1
public assignAllowFailure(allowFailure: boolean | number[]): Job
allowFailureRequired
  • Type: boolean | number[]
assignArtifacts 
1
public assignArtifacts(artifacts: Artifacts): Job
artifactsRequired
  • Type: @gcix/gcix.Artifacts
assignCache 
1
public assignCache(cache: Cache): Job
cacheRequired
  • Type: @gcix/gcix.Cache
assignDependencies 
1
public assignDependencies(dependencies: Job | JobCollection | Need[]): Job
dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
assignImage 
1
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.

imageRequired
  • Type: string | @gcix/gcix.Image
assignNeeds 
1
public assignNeeds(needs: Job | JobCollection | Need[]): Job
needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
assignTags 
1
public assignTags(tags: string[]): Job
tagsRequired
  • Type: string[]
copy 
1
public copy(): Job

Returns an independent, deep copy object of this job.

extendName 
1
public extendName(name: string): void

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

nameRequired
  • Type: string
extendStage 
1
public extendStage(stage: string): void

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

stageRequired
  • Type: string
extendStageValue 
1
public extendStageValue(stage: string): void

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

stageRequired
  • Type: string
getAllInstanceNames 
1
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.

childOptional
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection
isEqual 
1
public isEqual(comparable: IBase): boolean

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: @gcix/gcix.IBase
prependRules 
1
public prependRules(rules: Rule[]): Job
rulesRequired
  • Type: @gcix/gcix.Rule[]
prependScripts 
1
public prependScripts(scripts: string[]): Job
scriptsRequired
  • Type: string[]
render 
1
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.
pipenvVersionSpecifier string No description.
requirementsFile string No description.
tagsRequired 
1
public readonly tags: string[];
  • Type: string[]

Getter method to receive added tags.

allowFailureRequired 
1
public readonly allowFailure: string | boolean | number[];
  • Type: string | boolean | number[]
nameRequired 
1
public readonly name: string;
  • Type: string
orderedTagsRequired 
1
public readonly orderedTags: OrderedStringSet;
  • Type: @gcix/gcix.OrderedStringSet
parentsRequired 
1
public readonly parents: Job | JobCollection[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection[]
scriptsRequired 
1
public readonly scripts: string[];
  • Type: string[]
stageRequired 
1
public readonly stage: string;
  • Type: string
artifactsOptional 
1
public readonly artifacts: Artifacts;
  • Type: @gcix/gcix.Artifacts
cacheOptional 
1
public readonly cache: Cache;
  • Type: @gcix/gcix.Cache
dependenciesOptional 
1
public readonly dependencies: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
imageOptional 
1
public readonly image: Image;
  • Type: @gcix/gcix.Image
needsOptional 
1
public readonly needs: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
originalOptional 
1
public readonly original: Job;
  • Type: @gcix/gcix.Job
rulesOptional 
1
public readonly rules: Rule[];
  • Type: @gcix/gcix.Rule[]
variablesOptional 
1
public readonly variables: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
pipenvVersionSpecifierOptional 
1
public readonly pipenvVersionSpecifier: string;
  • Type: string
requirementsFileOptional 
1
public readonly requirementsFile: string;
  • Type: string

PythonDeployTwineUpload

Runs:.

1
2
pip3 install --upgrade twine
python3 -m twine upload --non-interactive --disable-progress-bar dist/*

Requires artifacts from a build job under dist/ (e.g. from BdistWheel())

This subclass of Job configures the following defaults for the superclass: - name: twine - stage: deploy

Initializers 

1
2
3
import { python } from '@gcix/gcix'

new python.PythonDeployTwineUpload(props: PythonDeployTwineUploadProps)
Name Type Description
props PythonDeployTwineUploadProps No description.
propsRequired

Methods

Name Description
addDependencies No description.
addNeeds No description.
addParent This method is called by gcix.JobCollections 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.JobCollections to populate the jobs name.
extendStage This method is used by gcix.JobCollections to populate the jobs name and stage.
extendStageValue This method is used by gcix.JobCollections 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 
1
public addDependencies(dependencies: Job | JobCollection | Need[]): Job
dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addNeeds 
1
public addNeeds(needs: Job | JobCollection | Need[]): Job
needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addParent 
1
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.

parentRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection
addTags 
1
public addTags(tags: string[]): Job
tagsRequired
  • Type: string[]
addVariables 
1
public addVariables(variables: {[ key: string ]: string}): Job
variablesRequired
  • Type: {[ key: string ]: string}
appendRules 
1
public appendRules(rules: Rule[]): Job
rulesRequired
  • Type: @gcix/gcix.Rule[]
appendScripts 
1
public appendScripts(scripts: string[]): Job
scriptsRequired
  • Type: string[]
assignAllowFailure 
1
public assignAllowFailure(allowFailure: boolean | number[]): Job
allowFailureRequired
  • Type: boolean | number[]
assignArtifacts 
1
public assignArtifacts(artifacts: Artifacts): Job
artifactsRequired
  • Type: @gcix/gcix.Artifacts
assignCache 
1
public assignCache(cache: Cache): Job
cacheRequired
  • Type: @gcix/gcix.Cache
assignDependencies 
1
public assignDependencies(dependencies: Job | JobCollection | Need[]): Job
dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
assignImage 
1
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.

imageRequired
  • Type: string | @gcix/gcix.Image
assignNeeds 
1
public assignNeeds(needs: Job | JobCollection | Need[]): Job
needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
assignTags 
1
public assignTags(tags: string[]): Job
tagsRequired
  • Type: string[]
copy 
1
public copy(): Job

Returns an independent, deep copy object of this job.

extendName 
1
public extendName(name: string): void

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

nameRequired
  • Type: string
extendStage 
1
public extendStage(stage: string): void

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

stageRequired
  • Type: string
extendStageValue 
1
public extendStageValue(stage: string): void

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

stageRequired
  • Type: string
getAllInstanceNames 
1
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.

childOptional
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection
isEqual 
1
public isEqual(comparable: IBase): boolean

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: @gcix/gcix.IBase
prependRules 
1
public prependRules(rules: Rule[]): Job
rulesRequired
  • Type: @gcix/gcix.Rule[]
prependScripts 
1
public prependScripts(scripts: string[]): Job
scriptsRequired
  • Type: string[]
render 
1
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.
twinePasswordEnvVar string The name of the environment variable containing the password.
twineUsernameEnvVar string The name of the environment variable containing the username value.
twineRepositoryUrl string The URL to the PyPI repository to which the Python artifacts will be deployed.
tagsRequired 
1
public readonly tags: string[];
  • Type: string[]

Getter method to receive added tags.

allowFailureRequired 
1
public readonly allowFailure: string | boolean | number[];
  • Type: string | boolean | number[]
nameRequired 
1
public readonly name: string;
  • Type: string
orderedTagsRequired 
1
public readonly orderedTags: OrderedStringSet;
  • Type: @gcix/gcix.OrderedStringSet
parentsRequired 
1
public readonly parents: Job | JobCollection[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection[]
scriptsRequired 
1
public readonly scripts: string[];
  • Type: string[]
stageRequired 
1
public readonly stage: string;
  • Type: string
artifactsOptional 
1
public readonly artifacts: Artifacts;
  • Type: @gcix/gcix.Artifacts
cacheOptional 
1
public readonly cache: Cache;
  • Type: @gcix/gcix.Cache
dependenciesOptional 
1
public readonly dependencies: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
imageOptional 
1
public readonly image: Image;
  • Type: @gcix/gcix.Image
needsOptional 
1
public readonly needs: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
originalOptional 
1
public readonly original: Job;
  • Type: @gcix/gcix.Job
rulesOptional 
1
public readonly rules: Rule[];
  • Type: @gcix/gcix.Rule[]
variablesOptional 
1
public readonly variables: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
twinePasswordEnvVarRequired 
1
public readonly twinePasswordEnvVar: string;
  • Type: string

The name of the environment variable containing the password.

DO NOT PROVIDE THE LOGIN VALUE ITSELF! This would be a security issue! Defaults to 'TWINE_PASSWORD'.

twineUsernameEnvVarRequired 
1
public readonly twineUsernameEnvVar: string;
  • Type: string

The name of the environment variable containing the username value.

DO NOT PROVIDE THE USERNAME VALUE ITSELF! This would be a security issue! Defaults to 'TWINE_USERNAME'.

twineRepositoryUrlOptional 
1
public readonly twineRepositoryUrl: string;
  • Type: string

The URL to the PyPI repository to which the Python artifacts will be deployed.

If undefined the package is published to https://pypi.org.

PythonFullStack

Returns a sequence containing following jobs: - isort - flake8 - pytest - evaluating CI_COMMIT_TAG as valid PyPI version string (if exists) - bdist_wheel - Gitlab Pages sphinx - twine upload Optional jobs: - mypy The varname_dev_password and varname_stable_password arguments are only used to specify the variable name and not the actuall password.

The variable name has to be set outside of the pipeline itself, if you set it within the pipline, that would be a security risk.

Initializers 

1
2
3
import { python } from '@gcix/gcix'

new python.PythonFullStack(props: PythonFullStackProps)
Name Type Description
props PythonFullStackProps No description.
propsRequired

Methods

Name Description
addChildren Add gcix.Jobs or other gcix.JobCollections to this JobCollection.
addDependencies No description.
addNeeds No description.
addParent No description.
addTags No description.
addVariables No description.
appendRules No description.
appendScripts No description.
assignArtifacts No description.
assignCache No description.
getAllInstanceNames Return all instance names from the given child.
initializeAllowFailure Calling gcix.Job.assignAllowFailure() to all jobs within this JobCollection that haven't been set the allowFailure before.
initializeArtifacts Sets gcix.Job.artifacts to all jobs within this JobCollection that haven't been set the artifacs before.
initializeCache Calling gcix.Job.assigneCache() to all jobs within this JobCollection that haven't been set the cache before.
initializeDependencies Calling gcix.Job.assignDependencies() to all jobs within the first stage of this JobCollection that haven't been added dependencies before.
initializeImage Calling gcix.Job.assignImage() to all jobs within this JobCollection.
initializeNeeds Calling gcix.Job.assignNeeds() to all jobs within the first stage of this JobCollection that haven't been added needs before.
initializeRules Calling gcix.Job.append_rules() to all jobs within this JobCollection that haven't been added rules before.
initializeTags Calling gcix.Job.addTags([...]) to all jobs within this JobCollection that haven't been added tags before.
initializeVariables Calling gcix.Job.addVariables({...}) to all jobs within this JobCollection that haven't been added variables before.
isEqual isEqual checks if this object is equal to given object.
overrideAllowFailure Calling gcix.Job.assignAllowFailure() to all jobs within this JobCollection overriding any previous set value.
overrideDependencies Calling gcix.Job.assignDependencies() to all jobs within the first stage of this JobCollection and overriding any previously added dependencies to that jobs.
overrideImage Calling gcix.Job.assignImage() to all jobs within this JobCollection overriding any previous set value.
overrideNeeds Calling gcix.Job.assignNeeds() to all jobs within the first stage of this JobCollection and overriding any previously added needs to that jobs.
overrideRules Calling gcix.Job.overrideRules() to all jobs within this JobCollection and overriding any previously added rules to that jobs.
overrideTags Calling gcix.Job.addTags([...]) to all jobs within this JobCollection and overriding any previously added tags to that jobs.
overrideVariables Calling gcix.Job.addVariables({...}) to all jobs within this JobCollection and overriding any previously added variables to that jobs.
prependRules No description.
prependScripts No description.
render Returns a representation of any object which implements IBase.
addChildren 
1
public addChildren(props: AddChildrenProps): JobCollection

Add gcix.Jobs or other gcix.JobCollections to this JobCollection.

Adding a child creates a copy of that child. You should provide a name or stage when adding children, to make them different from other places where they will be used.

propsRequired
  • Type: @gcix/gcix.AddChildrenProps
addDependencies 
1
public addDependencies(dependencies: Job | JobCollection | Need[]): JobCollection
dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addNeeds 
1
public addNeeds(needs: Job | JobCollection | Need[]): JobCollection
needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addParent 
1
public addParent(parent: JobCollection): void
parentRequired
  • Type: @gcix/gcix.JobCollection
addTags 
1
public addTags(tags: string[]): JobCollection
tagsRequired
  • Type: string[]
addVariables 
1
public addVariables(variables: {[ key: string ]: string}): JobCollection
variablesRequired
  • Type: {[ key: string ]: string}
appendRules 
1
public appendRules(rules: Rule[]): JobCollection
rulesRequired
  • Type: @gcix/gcix.Rule[]
appendScripts 
1
public appendScripts(scripts: string[]): JobCollection
scriptsRequired
  • Type: string[]
assignArtifacts 
1
public assignArtifacts(artifacts: Artifacts): JobCollection
artifactsRequired
  • Type: @gcix/gcix.Artifacts
assignCache 
1
public assignCache(cache: Cache): JobCollection
cacheRequired
  • Type: @gcix/gcix.Cache
getAllInstanceNames 
1
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 JobCollection and all parent JobCollection's.

childOptional
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection
initializeAllowFailure 
1
public initializeAllowFailure(allowFailure: boolean | number[]): JobCollection

Calling gcix.Job.assignAllowFailure() to all jobs within this JobCollection that haven't been set the allowFailure before.

allowFailureRequired
  • Type: boolean | number[]
initializeArtifacts 
1
public initializeArtifacts(artifacts: Artifacts): JobCollection

Sets gcix.Job.artifacts to all jobs within this JobCollection that haven't been set the artifacs before.

artifactsRequired
  • Type: @gcix/gcix.Artifacts
initializeCache 
1
public initializeCache(cache: Cache): JobCollection

Calling gcix.Job.assigneCache() to all jobs within this JobCollection that haven't been set the cache before.

cacheRequired
  • Type: @gcix/gcix.Cache
initializeDependencies 
1
public initializeDependencies(dependencies: Job | JobCollection | Need[]): JobCollection

Calling gcix.Job.assignDependencies() to all jobs within the first stage of this JobCollection that haven't been added dependencies before.

An empty parameter list means that jobs will get an empty dependency list and thus does not download artifacts by default.

dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
initializeImage 
1
public initializeImage(image: string | Image): JobCollection

Calling gcix.Job.assignImage() to all jobs within this JobCollection.

imageRequired
  • Type: string | @gcix/gcix.Image
initializeNeeds 
1
public initializeNeeds(needs: Job | JobCollection | Need[]): JobCollection

Calling gcix.Job.assignNeeds() to all jobs within the first stage of this JobCollection that haven't been added needs before.

An empty parameter list means that jobs will get an empty dependency list and thus does not depend on other jobs by default.

needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
initializeRules 
1
public initializeRules(rules: Rule[]): JobCollection

Calling gcix.Job.append_rules() to all jobs within this JobCollection that haven't been added rules before.

rulesRequired
  • Type: @gcix/gcix.Rule[]
initializeTags 
1
public initializeTags(tags: string[]): JobCollection

Calling gcix.Job.addTags([...]) to all jobs within this JobCollection that haven't been added tags before.

tagsRequired
  • Type: string[]
initializeVariables 
1
public initializeVariables(variables: {[ key: string ]: string}): JobCollection

Calling gcix.Job.addVariables({...}) to all jobs within this JobCollection that haven't been added variables before.

variablesRequired
  • Type: {[ key: string ]: string}
isEqual 
1
public isEqual(comparable: IBase): boolean

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: @gcix/gcix.IBase
overrideAllowFailure 
1
public overrideAllowFailure(allowFailure: boolean | number[]): JobCollection

Calling gcix.Job.assignAllowFailure() to all jobs within this JobCollection overriding any previous set value.

allowFailureRequired
  • Type: boolean | number[]
overrideDependencies 
1
public overrideDependencies(dependencies: Job | JobCollection | Need[]): JobCollection

Calling gcix.Job.assignDependencies() to all jobs within the first stage of this JobCollection and overriding any previously added dependencies to that jobs.

An empty parameter list means that jobs will get an empty dependency list and thus does not download artifacts.

dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
overrideImage 
1
public overrideImage(image: string | Image): JobCollection

Calling gcix.Job.assignImage() to all jobs within this JobCollection overriding any previous set value.

imageRequired
  • Type: string | @gcix/gcix.Image
overrideNeeds 
1
public overrideNeeds(needs: Job | JobCollection | Need[]): JobCollection

Calling gcix.Job.assignNeeds() to all jobs within the first stage of this JobCollection and overriding any previously added needs to that jobs.

An empty parameter list means that jobs will get an empty dependency list and thus does not depend on other jobs.

needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
overrideRules 
1
public overrideRules(rules: Rule[]): JobCollection

Calling gcix.Job.overrideRules() to all jobs within this JobCollection and overriding any previously added rules to that jobs.

rulesRequired
  • Type: @gcix/gcix.Rule[]
overrideTags 
1
public overrideTags(tags: string[]): JobCollection

Calling gcix.Job.addTags([...]) to all jobs within this JobCollection and overriding any previously added tags to that jobs.

tagsRequired
  • Type: string[]
overrideVariables 
1
public overrideVariables(variables: {[ key: string ]: string}): JobCollection

Calling gcix.Job.addVariables({...}) to all jobs within this JobCollection and overriding any previously added variables to that jobs.

variablesRequired
  • Type: {[ key: string ]: string}
prependRules 
1
public prependRules(rules: Rule[]): JobCollection
rulesRequired
  • Type: @gcix/gcix.Rule[]
prependScripts 
1
public prependScripts(scripts: string[]): JobCollection
scriptsRequired
  • Type: string[]
render 
1
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
lastJobsExecuted @gcix/gcix.Job[] This property returns all Jobs from the last stage of this JobCollection.
nestedJobs @gcix/gcix.Job[] No description.
populatedJobs @gcix/gcix.Job[] Returns a list with populated copies of all nested jobs of this JobCollection.
children @gcix/gcix.ChildDict[] No description.
orderedTags @gcix/gcix.OrderedStringSet No description.
orderedTagsForInitialization @gcix/gcix.OrderedStringSet No description.
orderedTagsForReplacement @gcix/gcix.OrderedStringSet No description.
parents @gcix/gcix.Job | @gcix/gcix.JobCollection[] No description.
allowFailureForInitialization string | boolean | number[] No description.
allowFailureForReplacement string | boolean | number[] No description.
artifacts @gcix/gcix.Artifacts No description.
artifactsForInitialization @gcix/gcix.Artifacts No description.
artifactsForReplacement @gcix/gcix.Artifacts No description.
cache @gcix/gcix.Cache No description.
cacheForInitialization @gcix/gcix.Cache No description.
dependencies @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[] No description.
dependenciesForInitialization @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[] No description.
dependenciesForReplacement @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[] No description.
imageForInitialization string | @gcix/gcix.Image No description.
imageForReplacement string | @gcix/gcix.Image No description.
needs @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[] No description.
needsForInitialization @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[] No description.
needsForReplacement @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[] No description.
rulesForInitialization @gcix/gcix.Rule[] No description.
rulesForReplacement @gcix/gcix.Rule[] No description.
rulesToAppend @gcix/gcix.Rule[] No description.
rulesToPrepend @gcix/gcix.Rule[] No description.
scriptsToAppend string[] No description.
scriptsToPrepend string[] No description.
variables {[ key: string ]: string} No description.
variablesForInitialization {[ key: string ]: string} No description.
variablesForReplacement {[ key: string ]: string} No description.
bDistWheelJob PythonBuildBdistWheel No description.
evaluateGitTagPep440ConformityJob PythonTestEvaluateGitTagPep440Conformity No description.
flake8Job PythonLintFlake8 No description.
isortJob PythonLintIsort No description.
pytestJob PythonTestPytest No description.
twineProdJob PythonDeployTwineUpload No description.
mypyJob PythonLintMyPy No description.
sphinxJob PagesSphinx No description.
twineDevJob PythonDeployTwineUpload No description.
lastJobsExecutedRequired 
1
public readonly lastJobsExecuted: Job[];
  • Type: @gcix/gcix.Job[]

This property returns all Jobs from the last stage of this JobCollection.

This is typically be requested from a job which has setup this JobCollection as need, to determine all actual jobs of this JobCollection as need.

nestedJobsRequired 
1
public readonly nestedJobs: Job[];
  • Type: @gcix/gcix.Job[]
populatedJobsRequired 
1
public readonly populatedJobs: Job[];
  • Type: @gcix/gcix.Job[]

Returns a list with populated copies of all nested jobs of this JobCollection.

Populated means, that all attributes of a Job which depends on its context are resolved to their final values. The context is primarily the JobCollection within the jobs resides but also dependencies to other jobs and JobCollection's. Thus this JobCollection will apply its own configuration, like variables to add, tags to set, etc., to all its jobs and JobCollection's.

Copies means what it says, that the returned job are not the same job objects, originally added to this JobCollection, but copies of them.

Nested means, that also jobs from JobCollection's within this JobCollection, are returned, as well as jobs from JobCollection's within JobCollection's within this JobCollection and so on.

childrenRequired 
1
public readonly children: ChildDict[];
  • Type: @gcix/gcix.ChildDict[]
orderedTagsRequired 
1
public readonly orderedTags: OrderedStringSet;
  • Type: @gcix/gcix.OrderedStringSet
orderedTagsForInitializationRequired 
1
public readonly orderedTagsForInitialization: OrderedStringSet;
  • Type: @gcix/gcix.OrderedStringSet
orderedTagsForReplacementRequired 
1
public readonly orderedTagsForReplacement: OrderedStringSet;
  • Type: @gcix/gcix.OrderedStringSet
parentsRequired 
1
public readonly parents: Job | JobCollection[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection[]
allowFailureForInitializationOptional 
1
public readonly allowFailureForInitialization: string | boolean | number[];
  • Type: string | boolean | number[]
allowFailureForReplacementOptional 
1
public readonly allowFailureForReplacement: string | boolean | number[];
  • Type: string | boolean | number[]
artifactsOptional 
1
public readonly artifacts: Artifacts;
  • Type: @gcix/gcix.Artifacts
artifactsForInitializationOptional 
1
public readonly artifactsForInitialization: Artifacts;
  • Type: @gcix/gcix.Artifacts
artifactsForReplacementOptional 
1
public readonly artifactsForReplacement: Artifacts;
  • Type: @gcix/gcix.Artifacts
cacheOptional 
1
public readonly cache: Cache;
  • Type: @gcix/gcix.Cache
cacheForInitializationOptional 
1
public readonly cacheForInitialization: Cache;
  • Type: @gcix/gcix.Cache
dependenciesOptional 
1
public readonly dependencies: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
dependenciesForInitializationOptional 
1
public readonly dependenciesForInitialization: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
dependenciesForReplacementOptional 
1
public readonly dependenciesForReplacement: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
imageForInitializationOptional 
1
public readonly imageForInitialization: string | Image;
  • Type: string | @gcix/gcix.Image
imageForReplacementOptional 
1
public readonly imageForReplacement: string | Image;
  • Type: string | @gcix/gcix.Image
needsOptional 
1
public readonly needs: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
needsForInitializationOptional 
1
public readonly needsForInitialization: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
needsForReplacementOptional 
1
public readonly needsForReplacement: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
rulesForInitializationOptional 
1
public readonly rulesForInitialization: Rule[];
  • Type: @gcix/gcix.Rule[]
rulesForReplacementOptional 
1
public readonly rulesForReplacement: Rule[];
  • Type: @gcix/gcix.Rule[]
rulesToAppendOptional 
1
public readonly rulesToAppend: Rule[];
  • Type: @gcix/gcix.Rule[]
rulesToPrependOptional 
1
public readonly rulesToPrepend: Rule[];
  • Type: @gcix/gcix.Rule[]
scriptsToAppendOptional 
1
public readonly scriptsToAppend: string[];
  • Type: string[]
scriptsToPrependOptional 
1
public readonly scriptsToPrepend: string[];
  • Type: string[]
variablesOptional 
1
public readonly variables: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
variablesForInitializationOptional 
1
public readonly variablesForInitialization: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
variablesForReplacementOptional 
1
public readonly variablesForReplacement: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
bDistWheelJobRequired 
1
public readonly bDistWheelJob: PythonBuildBdistWheel;
evaluateGitTagPep440ConformityJobRequired 
1
public readonly evaluateGitTagPep440ConformityJob: PythonTestEvaluateGitTagPep440Conformity;
flake8JobRequired 
1
public readonly flake8Job: PythonLintFlake8;
isortJobRequired 
1
public readonly isortJob: PythonLintIsort;
pytestJobRequired 
1
public readonly pytestJob: PythonTestPytest;
twineProdJobRequired 
1
public readonly twineProdJob: PythonDeployTwineUpload;
mypyJobOptional 
1
public readonly mypyJob: PythonLintMyPy;
sphinxJobOptional 
1
public readonly sphinxJob: PagesSphinx;
twineDevJobOptional 
1
public readonly twineDevJob: PythonDeployTwineUpload;

PythonLintFlake8

Runs:.

1
2
pip3 install --upgrade flake8
flake8

This subclass of Job configures the following defaults for the superclass: - name: flake8 - stage: lint

Initializers 

1
2
3
import { python } from '@gcix/gcix'

new python.PythonLintFlake8(props: PythonLintFlake8Props)
Name Type Description
props PythonLintFlake8Props No description.
propsRequired

Methods

Name Description
addDependencies No description.
addNeeds No description.
addParent This method is called by gcix.JobCollections 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.JobCollections to populate the jobs name.
extendStage This method is used by gcix.JobCollections to populate the jobs name and stage.
extendStageValue This method is used by gcix.JobCollections 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 
1
public addDependencies(dependencies: Job | JobCollection | Need[]): Job
dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addNeeds 
1
public addNeeds(needs: Job | JobCollection | Need[]): Job
needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addParent 
1
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.

parentRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection
addTags 
1
public addTags(tags: string[]): Job
tagsRequired
  • Type: string[]
addVariables 
1
public addVariables(variables: {[ key: string ]: string}): Job
variablesRequired
  • Type: {[ key: string ]: string}
appendRules 
1
public appendRules(rules: Rule[]): Job
rulesRequired
  • Type: @gcix/gcix.Rule[]
appendScripts 
1
public appendScripts(scripts: string[]): Job
scriptsRequired
  • Type: string[]
assignAllowFailure 
1
public assignAllowFailure(allowFailure: boolean | number[]): Job
allowFailureRequired
  • Type: boolean | number[]
assignArtifacts 
1
public assignArtifacts(artifacts: Artifacts): Job
artifactsRequired
  • Type: @gcix/gcix.Artifacts
assignCache 
1
public assignCache(cache: Cache): Job
cacheRequired
  • Type: @gcix/gcix.Cache
assignDependencies 
1
public assignDependencies(dependencies: Job | JobCollection | Need[]): Job
dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
assignImage 
1
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.

imageRequired
  • Type: string | @gcix/gcix.Image
assignNeeds 
1
public assignNeeds(needs: Job | JobCollection | Need[]): Job
needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
assignTags 
1
public assignTags(tags: string[]): Job
tagsRequired
  • Type: string[]
copy 
1
public copy(): Job

Returns an independent, deep copy object of this job.

extendName 
1
public extendName(name: string): void

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

nameRequired
  • Type: string
extendStage 
1
public extendStage(stage: string): void

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

stageRequired
  • Type: string
extendStageValue 
1
public extendStageValue(stage: string): void

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

stageRequired
  • Type: string
getAllInstanceNames 
1
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.

childOptional
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection
isEqual 
1
public isEqual(comparable: IBase): boolean

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: @gcix/gcix.IBase
prependRules 
1
public prependRules(rules: Rule[]): Job
rulesRequired
  • Type: @gcix/gcix.Rule[]
prependScripts 
1
public prependScripts(scripts: string[]): Job
scriptsRequired
  • Type: string[]
render 
1
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.
tagsRequired 
1
public readonly tags: string[];
  • Type: string[]

Getter method to receive added tags.

allowFailureRequired 
1
public readonly allowFailure: string | boolean | number[];
  • Type: string | boolean | number[]
nameRequired 
1
public readonly name: string;
  • Type: string
orderedTagsRequired 
1
public readonly orderedTags: OrderedStringSet;
  • Type: @gcix/gcix.OrderedStringSet
parentsRequired 
1
public readonly parents: Job | JobCollection[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection[]
scriptsRequired 
1
public readonly scripts: string[];
  • Type: string[]
stageRequired 
1
public readonly stage: string;
  • Type: string
artifactsOptional 
1
public readonly artifacts: Artifacts;
  • Type: @gcix/gcix.Artifacts
cacheOptional 
1
public readonly cache: Cache;
  • Type: @gcix/gcix.Cache
dependenciesOptional 
1
public readonly dependencies: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
imageOptional 
1
public readonly image: Image;
  • Type: @gcix/gcix.Image
needsOptional 
1
public readonly needs: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
originalOptional 
1
public readonly original: Job;
  • Type: @gcix/gcix.Job
rulesOptional 
1
public readonly rules: Rule[];
  • Type: @gcix/gcix.Rule[]
variablesOptional 
1
public readonly variables: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

PythonLintIsort

Runs:.

1
2
pip3 install --upgrade isort
isort --check .

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

  • name: isort
  • stage: lint

Initializers 

1
2
3
import { python } from '@gcix/gcix'

new python.PythonLintIsort(props: PythonLintIsortProps)
Name Type Description
props PythonLintIsortProps No description.
propsRequired

Methods

Name Description
addDependencies No description.
addNeeds No description.
addParent This method is called by gcix.JobCollections 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.JobCollections to populate the jobs name.
extendStage This method is used by gcix.JobCollections to populate the jobs name and stage.
extendStageValue This method is used by gcix.JobCollections 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 
1
public addDependencies(dependencies: Job | JobCollection | Need[]): Job
dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addNeeds 
1
public addNeeds(needs: Job | JobCollection | Need[]): Job
needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addParent 
1
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.

parentRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection
addTags 
1
public addTags(tags: string[]): Job
tagsRequired
  • Type: string[]
addVariables 
1
public addVariables(variables: {[ key: string ]: string}): Job
variablesRequired
  • Type: {[ key: string ]: string}
appendRules 
1
public appendRules(rules: Rule[]): Job
rulesRequired
  • Type: @gcix/gcix.Rule[]
appendScripts 
1
public appendScripts(scripts: string[]): Job
scriptsRequired
  • Type: string[]
assignAllowFailure 
1
public assignAllowFailure(allowFailure: boolean | number[]): Job
allowFailureRequired
  • Type: boolean | number[]
assignArtifacts 
1
public assignArtifacts(artifacts: Artifacts): Job
artifactsRequired
  • Type: @gcix/gcix.Artifacts
assignCache 
1
public assignCache(cache: Cache): Job
cacheRequired
  • Type: @gcix/gcix.Cache
assignDependencies 
1
public assignDependencies(dependencies: Job | JobCollection | Need[]): Job
dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
assignImage 
1
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.

imageRequired
  • Type: string | @gcix/gcix.Image
assignNeeds 
1
public assignNeeds(needs: Job | JobCollection | Need[]): Job
needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
assignTags 
1
public assignTags(tags: string[]): Job
tagsRequired
  • Type: string[]
copy 
1
public copy(): Job

Returns an independent, deep copy object of this job.

extendName 
1
public extendName(name: string): void

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

nameRequired
  • Type: string
extendStage 
1
public extendStage(stage: string): void

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

stageRequired
  • Type: string
extendStageValue 
1
public extendStageValue(stage: string): void

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

stageRequired
  • Type: string
getAllInstanceNames 
1
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.

childOptional
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection
isEqual 
1
public isEqual(comparable: IBase): boolean

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: @gcix/gcix.IBase
prependRules 
1
public prependRules(rules: Rule[]): Job
rulesRequired
  • Type: @gcix/gcix.Rule[]
prependScripts 
1
public prependScripts(scripts: string[]): Job
scriptsRequired
  • Type: string[]
render 
1
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.
tagsRequired 
1
public readonly tags: string[];
  • Type: string[]

Getter method to receive added tags.

allowFailureRequired 
1
public readonly allowFailure: string | boolean | number[];
  • Type: string | boolean | number[]
nameRequired 
1
public readonly name: string;
  • Type: string
orderedTagsRequired 
1
public readonly orderedTags: OrderedStringSet;
  • Type: @gcix/gcix.OrderedStringSet
parentsRequired 
1
public readonly parents: Job | JobCollection[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection[]
scriptsRequired 
1
public readonly scripts: string[];
  • Type: string[]
stageRequired 
1
public readonly stage: string;
  • Type: string
artifactsOptional 
1
public readonly artifacts: Artifacts;
  • Type: @gcix/gcix.Artifacts
cacheOptional 
1
public readonly cache: Cache;
  • Type: @gcix/gcix.Cache
dependenciesOptional 
1
public readonly dependencies: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
imageOptional 
1
public readonly image: Image;
  • Type: @gcix/gcix.Image
needsOptional 
1
public readonly needs: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
originalOptional 
1
public readonly original: Job;
  • Type: @gcix/gcix.Job
rulesOptional 
1
public readonly rules: Rule[];
  • Type: @gcix/gcix.Rule[]
variablesOptional 
1
public readonly variables: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

PythonLintMyPy

Install mypy if not already installed. Execute mypy for packageDir.

This subclass of Job configures the following defaults for the superclass: - name: mypy - stage: lint

Initializers 

1
2
3
import { python } from '@gcix/gcix'

new python.PythonLintMyPy(props: PythonLintMyPyProps)
Name Type Description
props PythonLintMyPyProps No description.
propsRequired

Methods

Name Description
addDependencies No description.
addNeeds No description.
addParent This method is called by gcix.JobCollections 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.JobCollections to populate the jobs name.
extendStage This method is used by gcix.JobCollections to populate the jobs name and stage.
extendStageValue This method is used by gcix.JobCollections 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 
1
public addDependencies(dependencies: Job | JobCollection | Need[]): Job
dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addNeeds 
1
public addNeeds(needs: Job | JobCollection | Need[]): Job
needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addParent 
1
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.

parentRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection
addTags 
1
public addTags(tags: string[]): Job
tagsRequired
  • Type: string[]
addVariables 
1
public addVariables(variables: {[ key: string ]: string}): Job
variablesRequired
  • Type: {[ key: string ]: string}
appendRules 
1
public appendRules(rules: Rule[]): Job
rulesRequired
  • Type: @gcix/gcix.Rule[]
appendScripts 
1
public appendScripts(scripts: string[]): Job
scriptsRequired
  • Type: string[]
assignAllowFailure 
1
public assignAllowFailure(allowFailure: boolean | number[]): Job
allowFailureRequired
  • Type: boolean | number[]
assignArtifacts 
1
public assignArtifacts(artifacts: Artifacts): Job
artifactsRequired
  • Type: @gcix/gcix.Artifacts
assignCache 
1
public assignCache(cache: Cache): Job
cacheRequired
  • Type: @gcix/gcix.Cache
assignDependencies 
1
public assignDependencies(dependencies: Job | JobCollection | Need[]): Job
dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
assignImage 
1
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.

imageRequired
  • Type: string | @gcix/gcix.Image
assignNeeds 
1
public assignNeeds(needs: Job | JobCollection | Need[]): Job
needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
assignTags 
1
public assignTags(tags: string[]): Job
tagsRequired
  • Type: string[]
copy 
1
public copy(): Job

Returns an independent, deep copy object of this job.

extendName 
1
public extendName(name: string): void

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

nameRequired
  • Type: string
extendStage 
1
public extendStage(stage: string): void

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

stageRequired
  • Type: string
extendStageValue 
1
public extendStageValue(stage: string): void

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

stageRequired
  • Type: string
getAllInstanceNames 
1
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.

childOptional
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection
isEqual 
1
public isEqual(comparable: IBase): boolean

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: @gcix/gcix.IBase
prependRules 
1
public prependRules(rules: Rule[]): Job
rulesRequired
  • Type: @gcix/gcix.Rule[]
prependScripts 
1
public prependScripts(scripts: string[]): Job
scriptsRequired
  • Type: string[]
render 
1
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.
packageDir string Package directory to type check.
myPyOptions string Adds arguments to mypy execution.
myPyVersion string If mypy is not already installed, this version will be installed.
tagsRequired 
1
public readonly tags: string[];
  • Type: string[]

Getter method to receive added tags.

allowFailureRequired 
1
public readonly allowFailure: string | boolean | number[];
  • Type: string | boolean | number[]
nameRequired 
1
public readonly name: string;
  • Type: string
orderedTagsRequired 
1
public readonly orderedTags: OrderedStringSet;
  • Type: @gcix/gcix.OrderedStringSet
parentsRequired 
1
public readonly parents: Job | JobCollection[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection[]
scriptsRequired 
1
public readonly scripts: string[];
  • Type: string[]
stageRequired 
1
public readonly stage: string;
  • Type: string
artifactsOptional 
1
public readonly artifacts: Artifacts;
  • Type: @gcix/gcix.Artifacts
cacheOptional 
1
public readonly cache: Cache;
  • Type: @gcix/gcix.Cache
dependenciesOptional 
1
public readonly dependencies: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
imageOptional 
1
public readonly image: Image;
  • Type: @gcix/gcix.Image
needsOptional 
1
public readonly needs: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
originalOptional 
1
public readonly original: Job;
  • Type: @gcix/gcix.Job
rulesOptional 
1
public readonly rules: Rule[];
  • Type: @gcix/gcix.Rule[]
variablesOptional 
1
public readonly variables: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
packageDirRequired 
1
public readonly packageDir: string;
  • Type: string

Package directory to type check.

myPyOptionsOptional 
1
public readonly myPyOptions: string;
  • Type: string

Adds arguments to mypy execution.

myPyVersionOptional 
1
public readonly myPyVersion: string;
  • Type: string

If mypy is not already installed, this version will be installed.

Installs latest version if undefined.

PythonScripts

Represents a collection of utility functions for scripting tasks.

Static Functions

Name Description
pipInstallRequirements Generates a shell command to install project requirements using pipenv and pip based on the presence of a Pipfile.lock or requirements.txt.
pipInstallRequirements 
1
2
3
import { python } from '@gcix/gcix'

python.PythonScripts.pipInstallRequirements(props: PipInstallRequirementsProps)

Generates a shell command to install project requirements using pipenv and pip based on the presence of a Pipfile.lock or requirements.txt.

propsRequired

An object containing the properties for installation.

PythonTestEvaluateGitTagPep440Conformity

Checks if the current pipelines $CI_COMMIT_TAG validates to a valid Python package version according to https://www.python.org/dev/peps/pep-0440.

This job already contains a rule to only run when a $CI_COMMIT_TAG is present (rules.only_tags()).

Runs pytest and installs project requirements before PythonScripts.pipInstallRequirements

  • Requires a requirements.txt in your project folder containing at least pytest

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

  • name: tag-pep440-conformity
  • stage: test
  • image: PredefinedImages.GCIP
  • rules: on_tagsg

Initializers 

1
2
3
import { python } from '@gcix/gcix'

new python.PythonTestEvaluateGitTagPep440Conformity(props: PythonTestEvaluateGitTagPep440ConformityProps)
Name Type Description
props PythonTestEvaluateGitTagPep440ConformityProps No description.
propsRequired

Methods

Name Description
addDependencies No description.
addNeeds No description.
addParent This method is called by gcix.JobCollections 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.JobCollections to populate the jobs name.
extendStage This method is used by gcix.JobCollections to populate the jobs name and stage.
extendStageValue This method is used by gcix.JobCollections 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 
1
public addDependencies(dependencies: Job | JobCollection | Need[]): Job
dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addNeeds 
1
public addNeeds(needs: Job | JobCollection | Need[]): Job
needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addParent 
1
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.

parentRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection
addTags 
1
public addTags(tags: string[]): Job
tagsRequired
  • Type: string[]
addVariables 
1
public addVariables(variables: {[ key: string ]: string}): Job
variablesRequired
  • Type: {[ key: string ]: string}
appendRules 
1
public appendRules(rules: Rule[]): Job
rulesRequired
  • Type: @gcix/gcix.Rule[]
appendScripts 
1
public appendScripts(scripts: string[]): Job
scriptsRequired
  • Type: string[]
assignAllowFailure 
1
public assignAllowFailure(allowFailure: boolean | number[]): Job
allowFailureRequired
  • Type: boolean | number[]
assignArtifacts 
1
public assignArtifacts(artifacts: Artifacts): Job
artifactsRequired
  • Type: @gcix/gcix.Artifacts
assignCache 
1
public assignCache(cache: Cache): Job
cacheRequired
  • Type: @gcix/gcix.Cache
assignDependencies 
1
public assignDependencies(dependencies: Job | JobCollection | Need[]): Job
dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
assignImage 
1
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.

imageRequired
  • Type: string | @gcix/gcix.Image
assignNeeds 
1
public assignNeeds(needs: Job | JobCollection | Need[]): Job
needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
assignTags 
1
public assignTags(tags: string[]): Job
tagsRequired
  • Type: string[]
copy 
1
public copy(): Job

Returns an independent, deep copy object of this job.

extendName 
1
public extendName(name: string): void

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

nameRequired
  • Type: string
extendStage 
1
public extendStage(stage: string): void

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

stageRequired
  • Type: string
extendStageValue 
1
public extendStageValue(stage: string): void

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

stageRequired
  • Type: string
getAllInstanceNames 
1
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.

childOptional
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection
isEqual 
1
public isEqual(comparable: IBase): boolean

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: @gcix/gcix.IBase
prependRules 
1
public prependRules(rules: Rule[]): Job
rulesRequired
  • Type: @gcix/gcix.Rule[]
prependScripts 
1
public prependScripts(scripts: string[]): Job
scriptsRequired
  • Type: string[]
render 
1
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.
tagsRequired 
1
public readonly tags: string[];
  • Type: string[]

Getter method to receive added tags.

allowFailureRequired 
1
public readonly allowFailure: string | boolean | number[];
  • Type: string | boolean | number[]
nameRequired 
1
public readonly name: string;
  • Type: string
orderedTagsRequired 
1
public readonly orderedTags: OrderedStringSet;
  • Type: @gcix/gcix.OrderedStringSet
parentsRequired 
1
public readonly parents: Job | JobCollection[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection[]
scriptsRequired 
1
public readonly scripts: string[];
  • Type: string[]
stageRequired 
1
public readonly stage: string;
  • Type: string
artifactsOptional 
1
public readonly artifacts: Artifacts;
  • Type: @gcix/gcix.Artifacts
cacheOptional 
1
public readonly cache: Cache;
  • Type: @gcix/gcix.Cache
dependenciesOptional 
1
public readonly dependencies: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
imageOptional 
1
public readonly image: Image;
  • Type: @gcix/gcix.Image
needsOptional 
1
public readonly needs: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
originalOptional 
1
public readonly original: Job;
  • Type: @gcix/gcix.Job
rulesOptional 
1
public readonly rules: Rule[];
  • Type: @gcix/gcix.Rule[]
variablesOptional 
1
public readonly variables: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

PythonTestPytest

Runs pytest and installs project requirements before PythonScripts.pipInstallRequirements.

Requires a Pipfile.lock or requirements.txt in your project folder containing at least pytest

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

  • name: pytest
  • stage: test

Initializers 

1
2
3
import { python } from '@gcix/gcix'

new python.PythonTestPytest(props: PythonTestPytestProps)
Name Type Description
props PythonTestPytestProps No description.
propsRequired

Methods

Name Description
addDependencies No description.
addNeeds No description.
addParent This method is called by gcix.JobCollections 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.JobCollections to populate the jobs name.
extendStage This method is used by gcix.JobCollections to populate the jobs name and stage.
extendStageValue This method is used by gcix.JobCollections 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 
1
public addDependencies(dependencies: Job | JobCollection | Need[]): Job
dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addNeeds 
1
public addNeeds(needs: Job | JobCollection | Need[]): Job
needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
addParent 
1
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.

parentRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection
addTags 
1
public addTags(tags: string[]): Job
tagsRequired
  • Type: string[]
addVariables 
1
public addVariables(variables: {[ key: string ]: string}): Job
variablesRequired
  • Type: {[ key: string ]: string}
appendRules 
1
public appendRules(rules: Rule[]): Job
rulesRequired
  • Type: @gcix/gcix.Rule[]
appendScripts 
1
public appendScripts(scripts: string[]): Job
scriptsRequired
  • Type: string[]
assignAllowFailure 
1
public assignAllowFailure(allowFailure: boolean | number[]): Job
allowFailureRequired
  • Type: boolean | number[]
assignArtifacts 
1
public assignArtifacts(artifacts: Artifacts): Job
artifactsRequired
  • Type: @gcix/gcix.Artifacts
assignCache 
1
public assignCache(cache: Cache): Job
cacheRequired
  • Type: @gcix/gcix.Cache
assignDependencies 
1
public assignDependencies(dependencies: Job | JobCollection | Need[]): Job
dependenciesRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
assignImage 
1
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.

imageRequired
  • Type: string | @gcix/gcix.Image
assignNeeds 
1
public assignNeeds(needs: Job | JobCollection | Need[]): Job
needsRequired
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
assignTags 
1
public assignTags(tags: string[]): Job
tagsRequired
  • Type: string[]
copy 
1
public copy(): Job

Returns an independent, deep copy object of this job.

extendName 
1
public extendName(name: string): void

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

nameRequired
  • Type: string
extendStage 
1
public extendStage(stage: string): void

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

stageRequired
  • Type: string
extendStageValue 
1
public extendStageValue(stage: string): void

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

stageRequired
  • Type: string
getAllInstanceNames 
1
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.

childOptional
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection
isEqual 
1
public isEqual(comparable: IBase): boolean

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: @gcix/gcix.IBase
prependRules 
1
public prependRules(rules: Rule[]): Job
rulesRequired
  • Type: @gcix/gcix.Rule[]
prependScripts 
1
public prependScripts(scripts: string[]): Job
scriptsRequired
  • Type: string[]
render 
1
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.
pipenvVersionSpecifier string The version hint of pipenv to install if Pipfile.lock is found. For example '==2022.08.15'. Defaults to latest package version.
pytestCommand string This argument is only required if you have a custom command to call pytest.
tagsRequired 
1
public readonly tags: string[];
  • Type: string[]

Getter method to receive added tags.

allowFailureRequired 
1
public readonly allowFailure: string | boolean | number[];
  • Type: string | boolean | number[]
nameRequired 
1
public readonly name: string;
  • Type: string
orderedTagsRequired 
1
public readonly orderedTags: OrderedStringSet;
  • Type: @gcix/gcix.OrderedStringSet
parentsRequired 
1
public readonly parents: Job | JobCollection[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection[]
scriptsRequired 
1
public readonly scripts: string[];
  • Type: string[]
stageRequired 
1
public readonly stage: string;
  • Type: string
artifactsOptional 
1
public readonly artifacts: Artifacts;
  • Type: @gcix/gcix.Artifacts
cacheOptional 
1
public readonly cache: Cache;
  • Type: @gcix/gcix.Cache
dependenciesOptional 
1
public readonly dependencies: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
imageOptional 
1
public readonly image: Image;
  • Type: @gcix/gcix.Image
needsOptional 
1
public readonly needs: Job | JobCollection | Need[];
  • Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]
originalOptional 
1
public readonly original: Job;
  • Type: @gcix/gcix.Job
rulesOptional 
1
public readonly rules: Rule[];
  • Type: @gcix/gcix.Rule[]
variablesOptional 
1
public readonly variables: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
pipenvVersionSpecifierRequired 
1
public readonly pipenvVersionSpecifier: string;
  • Type: string

The version hint of pipenv to install if Pipfile.lock is found. For example '==2022.08.15'. Defaults to latest package version.

pytestCommandRequired 
1
public readonly pytestCommand: string;
  • Type: string

This argument is only required if you have a custom command to call pytest.

Protocols

IPagesPdoc3

Properties

Name Type Description
module string The Python module name.
outputPath string A sub path of the Gitlab Pages public directory to output generated HTML/markdown files to.
moduleRequired 
1
public readonly module: string;
  • Type: string

The Python module name.

This may be an import path resolvable in the current environment, or a file path to a Python module or package.

outputPathRequired 
1
public readonly outputPath: string;
  • Type: string

A sub path of the Gitlab Pages public directory to output generated HTML/markdown files to.

Defaults to "/".

IPagesSphinx

Properties

Name Type Description
pip PipInstallRequirementsProps No description.
pipOptional 
1
public readonly pip: PipInstallRequirementsProps;

IPythonBuildBdistWheel

Properties

Name Type Description
pipenvVersionSpecifier string No description.
requirementsFile string No description.
pipenvVersionSpecifierOptional 
1
public readonly pipenvVersionSpecifier: string;
  • Type: string
requirementsFileOptional 
1
public readonly requirementsFile: string;
  • Type: string

IPythonDeployTwineUpload

Properties

Name Type Description
twinePasswordEnvVar string The name of the environment variable containing the password.
twineUsernameEnvVar string The name of the environment variable containing the username value.
twineRepositoryUrl string The URL to the PyPI repository to which the Python artifacts will be deployed.
twinePasswordEnvVarRequired 
1
public readonly twinePasswordEnvVar: string;
  • Type: string

The name of the environment variable containing the password.

DO NOT PROVIDE THE LOGIN VALUE ITSELF! This would be a security issue! Defaults to 'TWINE_PASSWORD'.

twineUsernameEnvVarRequired 
1
public readonly twineUsernameEnvVar: string;
  • Type: string

The name of the environment variable containing the username value.

DO NOT PROVIDE THE USERNAME VALUE ITSELF! This would be a security issue! Defaults to 'TWINE_USERNAME'.

twineRepositoryUrlOptional 
1
public readonly twineRepositoryUrl: string;
  • Type: string

The URL to the PyPI repository to which the Python artifacts will be deployed.

If undefined the package is published to https://pypi.org.

IPythonFullStack

Properties

Name Type Description
bDistWheelJob PythonBuildBdistWheel No description.
evaluateGitTagPep440ConformityJob PythonTestEvaluateGitTagPep440Conformity No description.
flake8Job PythonLintFlake8 No description.
isortJob PythonLintIsort No description.
pytestJob PythonTestPytest No description.
twineProdJob PythonDeployTwineUpload No description.
mypyJob PythonLintMyPy No description.
sphinxJob PagesSphinx No description.
twineDevJob PythonDeployTwineUpload No description.
bDistWheelJobRequired 
1
public readonly bDistWheelJob: PythonBuildBdistWheel;
evaluateGitTagPep440ConformityJobRequired 
1
public readonly evaluateGitTagPep440ConformityJob: PythonTestEvaluateGitTagPep440Conformity;
flake8JobRequired 
1
public readonly flake8Job: PythonLintFlake8;
isortJobRequired 
1
public readonly isortJob: PythonLintIsort;
pytestJobRequired 
1
public readonly pytestJob: PythonTestPytest;
twineProdJobRequired 
1
public readonly twineProdJob: PythonDeployTwineUpload;
mypyJobOptional 
1
public readonly mypyJob: PythonLintMyPy;
sphinxJobOptional 
1
public readonly sphinxJob: PagesSphinx;
twineDevJobOptional 
1
public readonly twineDevJob: PythonDeployTwineUpload;

IPythonLintFlake8

IPythonLintIsort

IPythonLintMyPy

Properties

Name Type Description
packageDir string Package directory to type check.
myPyOptions string Adds arguments to mypy execution.
myPyVersion string If mypy is not already installed, this version will be installed.
packageDirRequired 
1
public readonly packageDir: string;
  • Type: string

Package directory to type check.

myPyOptionsOptional 
1
public readonly myPyOptions: string;
  • Type: string

Adds arguments to mypy execution.

myPyVersionOptional 
1
public readonly myPyVersion: string;
  • Type: string

If mypy is not already installed, this version will be installed.

Installs latest version if undefined.

IPythonTestEvaluateGitTagPep440Conformity

IPythonTestPytest

Properties

Name Type Description
pipenvVersionSpecifier string The version hint of pipenv to install if Pipfile.lock is found. For example '==2022.08.15'. Defaults to latest package version.
pytestCommand string This argument is only required if you have a custom command to call pytest.
pipenvVersionSpecifierRequired 
1
public readonly pipenvVersionSpecifier: string;
  • Type: string

The version hint of pipenv to install if Pipfile.lock is found. For example '==2022.08.15'. Defaults to latest package version.

pytestCommandRequired 
1
public readonly pytestCommand: string;
  • Type: string

This argument is only required if you have a custom command to call pytest.