`gitlab` Submodule ¶

Structs ¶

PagesAsciiDoctorProps ¶

Initializer ¶

from gcix import gitlab

gitlab.PagesAsciiDoctorProps(
  out_file: str,
  source: str,
  job_name: str = None,
  job_stage: str = None
)

Properties ¶

Name	Type	Description
`out_file`	`str`	Output HTML file.
`source`	`str`	Source .adoc files to translate to HTML files.
`job_name`	`str`	The name of the job.
`job_stage`	`str`	The stage of the job.

`out_file`^Required ¶

out_file: str

Type: str

Output HTML file.

`source`^Required ¶

source: str

Type: str

Source .adoc files to translate to HTML files.

`job_name`^Optional ¶

job_name: str

Type: str

The name of the job.

`job_stage`^Optional ¶

job_stage: str

Type: str

The stage of the job.

Classes ¶

GitlabScripts ¶

GitlabScripts Class Documentation.

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

Static Functions ¶

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

`clone_repository` ¶

from gcix import gitlab

gitlab.GitlabScripts.clone_repository(
  path: str,
  branch: str = None
)

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

`path`^Required ¶

Type: str

The path of the repository to clone.

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

`branch`^Optional ¶

Type: str

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

Currently, only "main" is supported.

PagesAsciiDoctor ¶

Implements: IPagesAsciiDoctor

Translate the AsciiDoc source FILE as Gitlab Pages HTML5 file.

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

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

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

Initializers ¶

from gcix import gitlab

gitlab.PagesAsciiDoctor(
  out_file: str,
  source: str,
  job_name: str = None,
  job_stage: str = None
)

Name	Type	Description
`out_file`	`str`	Output HTML file.
`source`	`str`	Source .adoc files to translate to HTML files.
`job_name`	`str`	The name of the job.
`job_stage`	`str`	The stage of the job.

`out_file`^Required ¶

Type: str

Output HTML file.

`source`^Required ¶

Type: str

Source .adoc files to translate to HTML files.

`job_name`^Optional ¶

Type: str

The name of the job.

`job_stage`^Optional ¶

Type: str

The stage of the job.

Methods ¶

Name	Description
`add_dependencies`	No description.
`add_needs`	No description.
`add_parent`	This method is called by `gcix.JobCollection`s when the job is added to that JobCollection.
`add_tags`	No description.
`add_variables`	No description.
`append_rules`	No description.
`append_scripts`	No description.
`assign_allow_failure`	No description.
`assign_artifacts`	No description.
`assign_cache`	No description.
`assign_dependencies`	No description.
`assign_image`	Sets the image of this job.
`assign_needs`	No description.
`assign_tags`	No description.
`copy`	Returns an independent, deep copy object of this job.
`extend_name`	This method is used by `gcix.JobCollection`s to populate the jobs name.
`extend_stage`	This method is used by `gcix.JobCollection`s to populate the jobs name and stage.
`extend_stage_value`	This method is used by `gcix.JobCollection`s to populate the jobs stage.
`get_all_instance_names`	Return all instance names from the given child.
`is_equal`	`isEqual` checks if `this` object is equal to given object.
`prepend_rules`	No description.
`prepend_scripts`	No description.
`render`	Returns a representation of any object which implements `IBase`.

`add_dependencies` ¶

def add_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job

`dependencies`^Required ¶

Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]

`add_needs` ¶

def add_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job

`needs`^Required ¶

Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]

`add_parent` ¶

def add_parent(
  parent: typing.Union[Job, JobCollection]
) -> None

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

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

`parent`^Required ¶

Type: typing.Union[gcix.Job, gcix.JobCollection]

`add_tags` ¶

def add_tags(
  tags: typing.List[str]
) -> Job

`tags`^Required ¶

Type: typing.List[str]

`add_variables` ¶

def add_variables(
  variables: typing.Mapping[str]
) -> Job

`variables`^Required ¶

Type: typing.Mapping[str]

`append_rules` ¶

def append_rules(
  rules: typing.List[Rule]
) -> Job

`rules`^Required ¶

Type: typing.List[gcix.Rule]

`append_scripts` ¶

def append_scripts(
  scripts: typing.List[str]
) -> Job

`scripts`^Required ¶

Type: typing.List[str]

`assign_allow_failure` ¶

def assign_allow_failure(
  allow_failure: typing.Union[bool, typing.List[typing.Union[int, float]]]
) -> Job

`allow_failure`^Required ¶

Type: typing.Union[bool, typing.List[typing.Union[int, float]]]

`assign_artifacts` ¶

def assign_artifacts(
  artifacts: Artifacts
) -> Job

`artifacts`^Required ¶

Type: gcix.Artifacts

`assign_cache` ¶

def assign_cache(
  cache: Cache
) -> Job

`cache`^Required ¶

Type: gcix.Cache

`assign_dependencies` ¶

def assign_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job

`dependencies`^Required ¶

Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]

`assign_image` ¶

def assign_image(
  image: typing.Union[str, Image]
) -> Job

Sets the image of this job.

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

!! Any previous values will be overwritten.

`image`^Required ¶

Type: typing.Union[str, gcix.Image]

`assign_needs` ¶

def assign_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job

`needs`^Required ¶

Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]

`assign_tags` ¶

def assign_tags(
  tags: typing.List[str]
) -> Job

`tags`^Required ¶

Type: typing.List[str]

`copy` ¶

def copy() -> Job

Returns an independent, deep copy object of this job.

`extend_name` ¶

def extend_name(
  name: str
) -> None

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

`name`^Required ¶

Type: str

`extend_stage` ¶

def extend_stage(
  stage: str
) -> None

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

`stage`^Required ¶

Type: str

`extend_stage_value` ¶

def extend_stage_value(
  stage: str
) -> None

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

`stage`^Required ¶

Type: str

`get_all_instance_names` ¶

def get_all_instance_names(
  child: typing.Union[Job, JobCollection] = None
) -> OrderedStringSet

Return all instance names from the given child.

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

`child`^Optional ¶

Type: typing.Union[gcix.Job, gcix.JobCollection]

`is_equal` ¶

def is_equal(
  comparable: IBase
) -> bool

isEqual checks if this object is equal to given object.

`comparable`^Required ¶

Type: gcix.IBase

`prepend_rules` ¶

def prepend_rules(
  rules: typing.List[Rule]
) -> Job

`rules`^Required ¶

Type: typing.List[gcix.Rule]

`prepend_scripts` ¶

def prepend_scripts(
  scripts: typing.List[str]
) -> Job

`scripts`^Required ¶

Type: typing.List[str]

`render` ¶

def render() -> typing.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`	`typing.List[str]`	Getter method to receive added tags.
`allow_failure`	`typing.Union[str, bool, typing.List[typing.Union[int, float]]]`	No description.
`name`	`str`	No description.
`ordered_tags`	`gcix.OrderedStringSet`	No description.
`parents`	`typing.List[typing.Union[gcix.Job, gcix.JobCollection]]`	No description.
`scripts`	`typing.List[str]`	No description.
`stage`	`str`	No description.
`artifacts`	`gcix.Artifacts`	No description.
`cache`	`gcix.Cache`	No description.
`dependencies`	`typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]`	No description.
`image`	`gcix.Image`	No description.
`needs`	`typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]`	No description.
`original`	`gcix.Job`	No description.
`rules`	`typing.List[gcix.Rule]`	No description.
`variables`	`typing.Mapping[str]`	No description.
`out_file`	`str`	Output HTML file.
`source`	`str`	Source .adoc files to translate to HTML files.

`tags`^Required ¶

tags: typing.List[str]

Type: typing.List[str]

Getter method to receive added tags.

`allow_failure`^Required ¶

allow_failure: typing.Union[str, bool, typing.List[typing.Union[int, float]]]

Type: typing.Union[str, bool, typing.List[typing.Union[int, float]]]

`name`^Required ¶

name: str

Type: str

`ordered_tags`^Required ¶

ordered_tags: OrderedStringSet

Type: gcix.OrderedStringSet

`parents`^Required ¶

parents: typing.List[typing.Union[Job, JobCollection]]

Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection]]

`scripts`^Required ¶

scripts: typing.List[str]

Type: typing.List[str]

`stage`^Required ¶

stage: str

Type: str

`artifacts`^Optional ¶

artifacts: Artifacts

Type: gcix.Artifacts

`cache`^Optional ¶

cache: Cache

Type: gcix.Cache

`dependencies`^Optional ¶

dependencies: typing.List[typing.Union[Job, JobCollection, Need]]

Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]

`image`^Optional ¶

image: Image

Type: gcix.Image

`needs`^Optional ¶

needs: typing.List[typing.Union[Job, JobCollection, Need]]

Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]

`original`^Optional ¶

original: Job

Type: gcix.Job

`rules`^Optional ¶

rules: typing.List[Rule]

Type: typing.List[gcix.Rule]

`variables`^Optional ¶

variables: typing.Mapping[str]

Type: typing.Mapping[str]

`out_file`^Required ¶

out_file: str

Type: str

Output HTML file.

`source`^Required ¶

source: str

Type: str

Source .adoc files to translate to HTML files.

Protocols ¶

IPagesAsciiDoctor ¶

Implemented By: PagesAsciiDoctor, IPagesAsciiDoctor

Properties ¶

Name	Type	Description
`out_file`	`str`	Output HTML file.
`source`	`str`	Source .adoc files to translate to HTML files.

`out_file`^Required ¶

out_file: str

Type: str

Output HTML file.

`source`^Required ¶

source: str

Type: str

Source .adoc files to translate to HTML files.

Last update: November 14, 2023
Created: November 14, 2023

gitlab Submodule ¶

Structs ¶

PagesAsciiDoctorProps ¶

Initializer ¶

Properties ¶

out_fileRequired ¶

sourceRequired ¶

job_nameOptional ¶

job_stageOptional ¶

Classes ¶

GitlabScripts ¶

Static Functions ¶

clone_repository ¶

pathRequired ¶

branchOptional ¶

PagesAsciiDoctor ¶

Initializers ¶

out_fileRequired ¶

sourceRequired ¶

job_nameOptional ¶

job_stageOptional ¶

Methods ¶

add_dependencies ¶

dependenciesRequired ¶

add_needs ¶

needsRequired ¶

add_parent ¶

parentRequired ¶

add_tags ¶

tagsRequired ¶

add_variables ¶

variablesRequired ¶

append_rules ¶

rulesRequired ¶

append_scripts ¶

scriptsRequired ¶

assign_allow_failure ¶

allow_failureRequired ¶

assign_artifacts ¶

artifactsRequired ¶

assign_cache ¶

cacheRequired ¶

assign_dependencies ¶

dependenciesRequired ¶

assign_image ¶

imageRequired ¶

assign_needs ¶

needsRequired ¶

assign_tags ¶

tagsRequired ¶

copy ¶

extend_name ¶

nameRequired ¶

extend_stage ¶

stageRequired ¶

extend_stage_value ¶

stageRequired ¶

get_all_instance_names ¶

childOptional ¶

is_equal ¶

comparableRequired ¶

prepend_rules ¶

rulesRequired ¶

prepend_scripts ¶

scriptsRequired ¶

render ¶

Properties ¶

tagsRequired ¶

allow_failureRequired ¶

nameRequired ¶

ordered_tagsRequired ¶

parentsRequired ¶

scriptsRequired ¶

stageRequired ¶

artifactsOptional ¶

cacheOptional ¶

dependenciesOptional ¶

imageOptional ¶

needsOptional ¶

originalOptional ¶

`gitlab` Submodule ¶

`out_file`^Required ¶

`source`^Required ¶

`job_name`^Optional ¶

`job_stage`^Optional ¶

`clone_repository` ¶

`path`^Required ¶

`branch`^Optional ¶

`out_file`^Required ¶

`source`^Required ¶

`job_name`^Optional ¶

`job_stage`^Optional ¶

`add_dependencies` ¶

`dependencies`^Required ¶

`add_needs` ¶

`needs`^Required ¶

`add_parent` ¶

`parent`^Required ¶

`add_tags` ¶

`tags`^Required ¶

`add_variables` ¶

`variables`^Required ¶

`append_rules` ¶

`rules`^Required ¶

`append_scripts` ¶

`scripts`^Required ¶

`assign_allow_failure` ¶

`allow_failure`^Required ¶

`assign_artifacts` ¶

`artifacts`^Required ¶

`assign_cache` ¶

`cache`^Required ¶

`assign_dependencies` ¶

`dependencies`^Required ¶

`assign_image` ¶

`image`^Required ¶

`assign_needs` ¶

`needs`^Required ¶

`assign_tags` ¶

`tags`^Required ¶

`copy` ¶

`extend_name` ¶

`name`^Required ¶

`extend_stage` ¶

`stage`^Required ¶

`extend_stage_value` ¶

`stage`^Required ¶

`get_all_instance_names` ¶

`child`^Optional ¶

`is_equal` ¶

`comparable`^Required ¶

`prepend_rules` ¶

`rules`^Required ¶

`prepend_scripts` ¶

`scripts`^Required ¶

`render` ¶

`tags`^Required ¶

`allow_failure`^Required ¶

`name`^Required ¶

`ordered_tags`^Required ¶

`parents`^Required ¶

`scripts`^Required ¶

`stage`^Required ¶

`artifacts`^Optional ¶

`cache`^Optional ¶

`dependencies`^Optional ¶

`image`^Optional ¶

`needs`^Optional ¶

`original`^Optional ¶

`rules`^Optional ¶

`variables`^Optional ¶

`out_file`^Required ¶

`source`^Required ¶

`out_file`^Required ¶

`source`^Required ¶