Commitdd79eda

Gauvain Pocentek

committed

docs: tags API

1 parent5c51bf3 commitdd79edaCopy full SHA for dd79eda

File tree

+68

-0

lines changed

+68

-0

lines changed

Lines changed: 31 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -242,3 +242,34 @@`
`242`	`242`	`# or`
`243`	`243`	`f.delete(commit_message='Delete testfile')`
`244`	`244`	`# end files delete`
	`245`	`+`
	`246`	`+# tags list`
	`247`	`+tags=gl.project_tags.list(project_id=1)`
	`248`	`+# or`
	`249`	`+tags=project.tags.list()`
	`250`	`+# end tags list`
	`251`	`+`
	`252`	`+# tags get`
	`253`	`+tag=gl.project_tags.list('1.0',project_id=1)`
	`254`	`+# or`
	`255`	`+tags=project.tags.list('1.0')`
	`256`	`+# end tags get`
	`257`	`+`
	`258`	`+# tags create`
	`259`	`+tag=gl.project_tags.create({'tag_name':'1.0','ref':'master'},`
	`260`	`+project_id=1)`
	`261`	`+# or`
	`262`	`+tag=project.tags.create({'tag_name':'1.0','ref':'master'})`
	`263`	`+# end tags create`
	`264`	`+`
	`265`	`+# tags delete`
	`266`	`+gl.project_tags.delete('1.0',project_id=1)`
	`267`	`+# or`
	`268`	`+project.tags.delete('1.0')`
	`269`	`+# or`
	`270`	`+tag.delete()`
	`271`	`+# end tags delete`
	`272`	`+`
	`273`	`+# tags release`
	`274`	`+tag.set_release_description('awesome v1.0 release')`
	`275`	`+# end tags release`

Lines changed: 37 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -169,6 +169,43 @@ Delete a file:`
`169`	`169`	`:start-after: # files delete`
`170`	`170`	`:end-before: # end files delete`
`171`	`171`
	`172`	`+Tags`
	`173`	`+----`
	`174`	`+`
	`175`	+Use:class:`~gitlab.objects.ProjectTag` objects to manipulate tags. The
	`176`	+:attr:`gitlab.Gitlab.project_tags` and:attr:`Project.tags
	`177`	+<gitlab.objects.Project.tags>` manager objects provide helper functions.
	`178`	`+`
	`179`	`+List the project tags:`
	`180`	`+`
	`181`	`+..literalinclude::projects.py`
	`182`	`+:start-after: # tags list`
	`183`	`+:end-before: # end tags list`
	`184`	`+`
	`185`	`+Get a tag:`
	`186`	`+`
	`187`	`+..literalinclude::projects.py`
	`188`	`+:start-after: # tags get`
	`189`	`+:end-before: # end tags get`
	`190`	`+`
	`191`	`+Create a tag:`
	`192`	`+`
	`193`	`+..literalinclude::projects.py`
	`194`	`+:start-after: # tags create`
	`195`	`+:end-before: # end tags create`
	`196`	`+`
	`197`	`+Set or update the release note for a tag:`
	`198`	`+`
	`199`	`+..literalinclude::projects.py`
	`200`	`+:start-after: # tags release`
	`201`	`+:end-before: # end tags release`
	`202`	`+`
	`203`	`+Delete a tag:`
	`204`	`+`
	`205`	`+..literalinclude::projects.py`
	`206`	`+:start-after: # tags delete`
	`207`	`+:end-before: # end tags delete`
	`208`	`+`
`172`	`209`	`Events`
`173`	`210`	`------`
`174`	`211`

Comments

(0)