feat(api): add content_ref and dry_run_ref parameters to ProjectCiLin… · python-gitlab/python-gitlab@e8d2538 · GitHub

python-gitlab / python-gitlab Public

• Notifications You must be signed in to change notification settings
• Fork 672
• Star 2.5k

• Code
• Issues 15
• Pull requests 15
• Discussions
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit e8d2538

Browse filesBrowse the repository at this point in the historyBrowse files

JohnVillalovos

authored and

nejch

committed

feat(api): add content_ref and dry_run_ref parameters to ProjectCiLintManager

Add support for the new GitLab API parameters for validating existing CI/CD configurations: - content_ref: specify the branch, tag, or SHA to validate - dry_run_ref: set branch/tag context for dry run simulations The deprecated 'ref' parameter is kept for backward compatibility. Also update documentation with examples showing how to validate CI configuration from specific branches and with dry run simulation. Fixes #3260

1 parent 2982f20 commit e8d2538
Copy full SHA for e8d2538

2 files changed

+20-1Lines changed: 20 additions & 1 deletion

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• docs/gl_objects
  • ci_lint.rst
• gitlab/v4/objects
  • ci_lint.py

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎docs/gl_objects/ci_lint.rst‎

Copy file name to clipboardExpand all lines: docs/gl_objects/ci_lint.rst

+12Lines changed: 12 additions & 0 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -46,6 +46,18 @@ Lint a project's CI configuration::
46	46	assert lint_result.valid is True # Test that the .gitlab-ci.yml is valid
47	47	print(lint_result.merged_yaml) # Print the merged YAML file
48	48
	49	+ Lint a project's CI configuration from a specific branch or tag::
	50	+
	51	+ lint_result = project.ci_lint.get(content_ref="main")
	52	+ assert lint_result.valid is True # Test that the .gitlab-ci.yml is valid
	53	+ print(lint_result.merged_yaml) # Print the merged YAML file
	54	+
	55	+ Lint a project's CI configuration with dry run simulation::
	56	+
	57	+ lint_result = project.ci_lint.get(dry_run=True, dry_run_ref="develop")
	58	+ assert lint_result.valid is True # Test that the .gitlab-ci.yml is valid
	59	+ print(lint_result.merged_yaml) # Print the merged YAML file
	60	+
49	61	Lint a CI YAML configuration with a namespace::
50	62
51	63	lint_result = project.ci_lint.create({"content": gitlab_ci_yml})

Collapse file

‎gitlab/v4/objects/ci_lint.py‎

Copy file name to clipboardExpand all lines: gitlab/v4/objects/ci_lint.py

+8-1Lines changed: 8 additions & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -51,7 +51,14 @@ class ProjectCiLintManager(
51	51	_path = "/projects/{project_id}/ci/lint"
52	52	_obj_cls = ProjectCiLint
53	53	_from_parent_attrs = {"project_id": "id"}
54		- _optional_get_attrs = ("dry_run", "include_jobs", "ref")
	54	+ _optional_get_attrs = (
	55	+ "content_ref",
	56	+ "dry_run",
	57	+ "dry_run_ref",
	58	+ "include_jobs",
	59	+ "ref",
	60	+ )
	61	+
55	62	_create_attrs = RequiredOptional(
56	63	required=("content",), optional=("dry_run", "include_jobs", "ref")
57	64	)

0 commit comments

Comments

0 (0)