Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commita47dfcd

Browse files
committed
docs(packages): add examples for Packages API and cli usage
1 parent7ea178b commita47dfcd

File tree

3 files changed

+93
-0
lines changed

3 files changed

+93
-0
lines changed

‎docs/api-objects.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ API examples
3232
gl_objects/milestones
3333
gl_objects/namespaces
3434
gl_objects/notes
35+
gl_objects/packages
3536
gl_objects/pagesdomains
3637
gl_objects/pipelines_and_jobs
3738
gl_objects/projects

‎docs/cli.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,30 @@ List deploy tokens for a group:
235235
236236
$ gitlab -v group-deploy-token list --group-id 3
237237
238+
List packages for a project:
239+
240+
..code-block::console
241+
242+
$ gitlab -v project-package list --project-id 3
243+
244+
List packages for a group:
245+
246+
..code-block::console
247+
248+
$ gitlab -v group-package list --group-id 3
249+
250+
Get a specific project package by id:
251+
252+
..code-block::console
253+
254+
$ gitlab -v project-package get --id 1 --project-id 3
255+
256+
Delete a specific project package by id:
257+
258+
..code-block::console
259+
260+
$ gitlab -v project-package delete --id 1 --project-id 3
261+
238262
Get a list of snippets for this project:
239263

240264
..code-block::console

‎docs/gl_objects/packages.rst

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
#######
2+
Packages
3+
#######
4+
5+
Packages allow you to utilize GitLab as a private repository for a variety
6+
of common package managers.
7+
8+
Project Packages
9+
=====================
10+
11+
Reference
12+
---------
13+
14+
* v4 API:
15+
16+
+:class:`gitlab.v4.objects.ProjectPackage`
17+
+:class:`gitlab.v4.objects.ProjectPackageManager`
18+
+:attr:`gitlab.v4.objects.Project.packages`
19+
20+
* GitLab API: https://docs.gitlab.com/ee/api/packages.html#within-a-project
21+
22+
Examples
23+
--------
24+
25+
List the packages in a project::
26+
27+
packages = project.packages.list()
28+
29+
Filter the results by ``package_type`` or ``package_name`` ::
30+
31+
packages = project.packages.list(package_type='pypi')
32+
33+
Get a specific package of a project by id::
34+
35+
package = project.packages.get(1)
36+
37+
Delete a package from a project::
38+
39+
package.delete()
40+
# or
41+
project.packages.delete(package.id)
42+
43+
44+
Group Packages
45+
===================
46+
47+
Reference
48+
---------
49+
50+
* v4 API:
51+
52+
+:class:`gitlab.v4.objects.GroupPackage`
53+
+:class:`gitlab.v4.objects.GroupPackageManager`
54+
+:attr:`gitlab.v4.objects.Group.packages`
55+
56+
* GitLab API: https://docs.gitlab.com/ee/api/packages.html#within-a-group
57+
58+
Examples
59+
--------
60+
61+
List the packages in a group::
62+
63+
packages = group.packages.list()
64+
65+
Filter the results by ``package_type`` or ``package_name`` ::
66+
67+
packages = group.packages.list(package_type='pypi')
68+

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp