project_ci_cd_settings
Gets or lists a project_ci_cd_settings resource.
Overview​
| Name | project_ci_cd_settings |
| Type | Resource |
| Id | gitlab.ci.project_ci_cd_settings |
Fields​
The following fields are returned by SELECT queries:
- get
GraphQL response envelope
| Name | Datatype | Description |
|---|---|---|
cross_project_push_for_job_token_allowed | boolean | Indicates the ability to push to this repository using a job token from an allowlisted project |
display_pipeline_variables | boolean | Indicates whether pipeline variables can be displayed in the UI. |
group_runners_enabled | boolean | Indicates whether group runners are enabled for the project. |
inbound_job_token_scope_enabled | boolean | Indicates whether CI/CD job tokens generated in other projects have restricted access to this project. |
job_token_scope_enabled | boolean | Indicates whether CI/CD job tokens generated in this project have restricted access to other projects. |
keep_latest_artifact | boolean | Indicates whether the latest artifact should be kept for the project. |
max_pipelines_per_merge_train | integer | Maximum number of parallel pipelines per merge train. When null, the plan limit applies. |
merge_pipelines_enabled | boolean | Indicates whether merged results pipelines are enabled. |
merge_train_enforcement | string | Merge train enforcement level for the project. Ignored unless the merge_train_enforcement feature flag is enabled. (ALLOW_BYPASS, ENFORCE_FOR_ALL_USERS, ENFORCE_WITH_OWNER_OVERRIDE) |
merge_trains_enabled | boolean | Whether merge trains are enabled. |
merge_trains_skip_train_allowed | boolean | Whether merge immediately is allowed for merge trains. |
pipeline_variables_minimum_override_role | string | Minimum role required to set variables when creating a pipeline or running a job. |
project | object | Project identity (id, full_path, name) |
push_repository_for_job_token_allowed | boolean | Indicates the ability to push to the original project repository using a job token |
resource_group_default_process_mode | string | Default process mode for resource groups. (UNORDERED, OLDEST_FIRST, NEWEST_FIRST, NEWEST_READY_FIRST) |
skip_branch_pipelines_for_mrs | boolean | Indicates whether branch pipelines are skipped if a merge request is open. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | full_path, host | CI/CD settings for the project. Generated from the GitLab GraphQL schema field Project.ciCdSettings (ProjectCiCdSetting). |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
full_path | string | Full path of the project, for example gitlab-org/gitlab |
host | string | GitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST) |
SELECT examples​
- get
CI/CD settings for the project. Generated from the GitLab GraphQL schema field Project.ciCdSettings (ProjectCiCdSetting).
SELECT
cross_project_push_for_job_token_allowed,
display_pipeline_variables,
group_runners_enabled,
inbound_job_token_scope_enabled,
job_token_scope_enabled,
keep_latest_artifact,
max_pipelines_per_merge_train,
merge_pipelines_enabled,
merge_train_enforcement,
merge_trains_enabled,
merge_trains_skip_train_allowed,
pipeline_variables_minimum_override_role,
project,
push_repository_for_job_token_allowed,
resource_group_default_process_mode,
skip_branch_pipelines_for_mrs
FROM gitlab.ci.project_ci_cd_settings
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;