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

Commitbd7d2f6

Browse files
author
Gauvain Pocentek
committed
[docs] Add doc for snippets
1 parent0a4d40e commitbd7d2f6

File tree

4 files changed

+77
-0
lines changed

4 files changed

+77
-0
lines changed

‎docs/api-objects.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ API objects manipulation
2323
gl_objects/projects
2424
gl_objects/runners
2525
gl_objects/settings
26+
gl_objects/snippets
2627
gl_objects/system_hooks
2728
gl_objects/templates
2829
gl_objects/todos

‎docs/gl_objects/projects.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,8 @@ Delete a tag:
216216
:start-after: # tags delete
217217
:end-before: # end tags delete
218218

219+
.. _project_snippets:
220+
219221
Snippets
220222
--------
221223

‎docs/gl_objects/snippets.py

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# list
2+
snippets=gl.snippets.list()
3+
# end list
4+
5+
# get
6+
snippet=gl.snippets.get(snippet_id)
7+
# get the content
8+
content=snippet.content()
9+
# end get
10+
11+
# create
12+
snippet=gl.snippets.create({'title':'snippet1',
13+
'file_name':'snippet1.py',
14+
'content':open('snippet1.py').read()})
15+
# end create
16+
17+
# update
18+
snippet.visibility_level=gitlab.VISIBILITY_PUBLIC
19+
snippet.save()
20+
# end update
21+
22+
# delete
23+
gl.snippets.delete(snippet_id)
24+
# or
25+
snippet.delete()
26+
# end delete

‎docs/gl_objects/snippets.rst

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
########
2+
Snippets
3+
########
4+
5+
You can store code snippets in Gitlab. Snippets can be attached to projects
6+
(see:ref:`project_snippets`), but can also be detached.
7+
8+
* Object class::class:`gitlab.objects.Namespace`
9+
* Manager object::attr:`gitlab.Gitlab.snippets`
10+
11+
Examples
12+
========
13+
14+
List snippets:
15+
16+
..literalinclude::snippets.py
17+
:start-after: # list
18+
:end-before: # end list
19+
20+
Get a snippet:
21+
22+
..literalinclude::snippets.py
23+
:start-after: # get
24+
:end-before: # end get
25+
26+
..warning::
27+
28+
Blobs are entirely stored in memory unless you use the streaming feature.
29+
See:ref:`the artifacts example<streaming_example>`.
30+
31+
32+
Create a snippet:
33+
34+
..literalinclude::snippets.py
35+
:start-after: # create
36+
:end-before: # end create
37+
38+
Update a snippet:
39+
40+
..literalinclude::snippets.py
41+
:start-after: # update
42+
:end-before: # end update
43+
44+
Delete a snippet:
45+
46+
..literalinclude::snippets.py
47+
:start-after: # delete
48+
:end-before: # end delete

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp