summaryrefslogtreecommitdiff
path: root/docs/gl_objects/templates.rst
blob: 1ce429d3ce374d9752aead48a66a18c1dc996b0d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
#########
Templates
#########

You can request templates for different type of files:

* License files
* .gitignore files
* GitLab CI configuration files

License templates
=================

* Object class: :class:`~gitlab.objects.License`
* Manager object: :attr:`gitlab.Gitlab.licenses`

Examples
--------

List known license templates:

.. literalinclude:: templates.py
   :start-after: # license list
   :end-before: # end license list

Generate a license content for a project:

.. literalinclude:: templates.py
   :start-after: # license get
   :end-before: # end license get

.gitignore templates
====================

* Object class: :class:`~gitlab.objects.Gitignore`
* Manager object: :attr:`gitlab.Gitlab.gitognores`

Examples
--------

List known gitignore templates:

.. literalinclude:: templates.py
   :start-after: # gitignore list
   :end-before: # end gitignore list

Get a gitignore template:

.. literalinclude:: templates.py
   :start-after: # gitignore get
   :end-before: # end gitignore get

GitLab CI templates
===================

* Object class: :class:`~gitlab.objects.Gitlabciyml`
* Manager object: :attr:`gitlab.Gitlab.gitlabciymls`

Examples
--------

List known GitLab CI templates:

.. literalinclude:: templates.py
   :start-after: # gitlabciyml list
   :end-before: # end gitlabciyml list

Get a GitLab CI template:

.. literalinclude:: templates.py
   :start-after: # gitlabciyml get
   :end-before: # end gitlabciyml get