Templates

You can request templates for different type of files:

• License files

• .gitignore files

• GitLab CI configuration files

• Dockerfiles

License templates

Reference

• v4 API:

  • gitlab.v4.objects.License

  • gitlab.v4.objects.LicenseManager

  • gitlab.Gitlab.licenses

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

Examples

List known license templates:

licenses = gl.licenses.list()

Generate a license content for a project:

license = gl.licenses.get('apache-2.0', project='foobar', fullname='John Doe')
print(license.content)

.gitignore templates

Reference

• v4 API:

  • gitlab.v4.objects.Gitignore

  • gitlab.v4.objects.GitignoreManager

  • gitlab.Gitlab.gitignores

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

Examples

List known gitignore templates:

gitignores = gl.gitignores.list()

Get a gitignore template:

gitignore = gl.gitignores.get('Python')
print(gitignore.content)

GitLab CI templates

Reference

• v4 API:

  • gitlab.v4.objects.Gitlabciyml

  • gitlab.v4.objects.GitlabciymlManager

  • gitlab.Gitlab.gitlabciymls

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

Examples

List known GitLab CI templates:

gitlabciymls = gl.gitlabciymls.list()

Get a GitLab CI template:

gitlabciyml = gl.gitlabciymls.get('Pelican')
print(gitlabciyml.content)

Dockerfile templates

Reference

• v4 API:

  • gitlab.v4.objects.Dockerfile

  • gitlab.v4.objects.DockerfileManager

  • gitlab.Gitlab.gitlabciymls

• GitLab API: Not documented.

Examples

List known Dockerfile templates:

dockerfiles = gl.dockerfiles.list()

Get a Dockerfile template:

dockerfile = gl.dockerfiles.get('Python')
print(dockerfile.content)