Skip to content

index.md

Latest commit

 

History

History
29 lines (22 loc) · 1.33 KB

index.md

File metadata and controls

29 lines (22 loc) · 1.33 KB

PipelineConfig

Configuration for the Jenkins pipeline generator.
This is what should be at the top of the config file.
It defines all the general settings, such as the project configuration, the global jenkins configuration, and the features to be used in the pipeline.

  • pipeline_name: Pipeline name. Used as an identifier at the top of the jenkinsfile ( (Required) Type: str )

  • project: Project Configuration ( (Required) Type: ProjectConfig )

    • name: The project name. Used in various places in the Jenkinsfile. ( (Required) Type: str )

  • jenkins: Jenkins Configuration ( (Required) Type: JenkinsConfig )

    • workspace_suffix: Suffix to append to the Jenkins workspace path ( Type: Optional[str] Default: None )

    • default_node_names: The names of the nodes to use by default by Jenkins for each stage ( (Required) Type: str )

  • features: All the features that you want to use in your jenkins file ( Type: Dict[str, Any] Default: {} )

Features