fix(files): add optional ref parameter for cli project-file raw (#3032)

ebishop · nejch · commit b4e1d5692055 · 2025-01-22T17:52:05.000+01:00
The 
ef parameter was removed in python-gitlab v4.8.0.  This will add 
ef back as an optional parameter for the project-file raw cli command.
diff --git a/gitlab/v4/objects/files.py b/gitlab/v4/objects/files.py
@@ -277,6 +277,7 @@ def delete(  # type: ignore[override]
     @cli.register_custom_action(
         cls_names="ProjectFileManager",
         required=("file_path",),
+        optional=("ref",),
     )
     @exc.on_http_error(exc.GitlabGetError)
     def raw(
diff --git a/tests/functional/cli/test_cli_files.py b/tests/functional/cli/test_cli_files.py
@@ -0,0 +1,21 @@
+def test_project_file_raw(gitlab_cli, project, project_file):
+    cmd = ["project-file", "raw", "--project-id", project.id, "--file-path", "README"]
+    ret = gitlab_cli(cmd)
+    assert ret.success
+    assert "Initial content" in ret.stdout
+
+
+def test_project_file_raw_ref(gitlab_cli, project, project_file):
+    cmd = [
+        "project-file",
+        "raw",
+        "--project-id",
+        project.id,
+        "--file-path",
+        "README",
+        "--ref",
+        "main",
+    ]
+    ret = gitlab_cli(cmd)
+    assert ret.success
+    assert "Initial content" in ret.stdout

Original file line number	Diff line number	Diff line change
`@@ -277,6 +277,7 @@ def delete( # type: ignore[override]`
`277`	`277`	`@cli.register_custom_action(`
`278`	`278`	`cls_names="ProjectFileManager",`
`279`	`279`	`required=("file_path",),`
	`280`	`+ optional=("ref",),`
`280`	`281`	`)`
`281`	`282`	`@exc.on_http_error(exc.GitlabGetError)`
`282`	`283`	`def raw(`