summaryrefslogtreecommitdiff
path: root/docs/gl_objects/templates.rst
blob: c43b7ae605e7242a0d0ad1f24e64804f45dd60fe (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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
#########
Templates
#########

You can request templates for different type of files:

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

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

Reference
---------

* v4 API:

  + :class:`gitlab.v4.objects.License`
  + :class:`gitlab.v4.objects.LicenseManager`
  + :attr:`gitlab.Gitlab.licenses`

* v3 API:

  + :class:`gitlab.v3.objects.License`
  + :class:`gitlab.v3.objects.LicenseManager`
  + :attr:`gitlab.Gitlab.licenses`

* GitLab API: https://docs.gitlab.com/ce/api/templates/licenses.html

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
====================

Reference
---------

* v4 API:

  + :class:`gitlab.v4.objects.Gitignore`
  + :class:`gitlab.v4.objects.GitignoreManager`
  + :attr:`gitlab.Gitlab.gitignores`

* v3 API:

  + :class:`gitlab.v3.objects.Gitignore`
  + :class:`gitlab.v3.objects.GitignoreManager`
  + :attr:`gitlab.Gitlab.gitignores`

* GitLab API: https://docs.gitlab.com/ce/api/templates/gitignores.html

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
===================

Reference
---------

* v4 API:

  + :class:`gitlab.v4.objects.Gitlabciyml`
  + :class:`gitlab.v4.objects.GitlabciymlManager`
  + :attr:`gitlab.Gitlab.gitlabciymls`

* v3 API:

  + :class:`gitlab.v3.objects.Gitlabciyml`
  + :class:`gitlab.v3.objects.GitlabciymlManager`
  + :attr:`gitlab.Gitlab.gitlabciymls`

* GitLab API: https://docs.gitlab.com/ce/api/templates/gitlab_ci_ymls.html

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

Dockerfile templates
====================

Reference
---------

* v4 API:

  + :class:`gitlab.v4.objects.Dockerfile`
  + :class:`gitlab.v4.objects.DockerfileManager`
  + :attr:`gitlab.Gitlab.gitlabciymls`

* GitLab API: Not documented.

Examples
--------

List known Dockerfile templates:

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

Get a Dockerfile template:

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