docs: commits API

1 files changed, 50 insertions, 0 deletions

diff --git a/docs/gl_objects/commits.py b/docs/gl_objects/commits.py
new file mode 100644
index 0000000..3046513
--- /dev/null
+++ b/docs/gl_objects/commits.py
@@ -0,0 +1,50 @@
+# list
+commits = gl.project_commits.list(project_id=1)
+# or
+commits = project.commits.list()
+# end list
+
+# filter list
+commits = project.commits.list(ref_name='my_branch')
+commits = project.commits.list(since='2016-01-01T00:00:00Z')
+# end filter list
+
+# get
+commit = gl.project_commits.get('e3d5a71b', project_id=1)
+# or
+commit = project.commits.get('e3d5a71b')
+# end get
+
+# diff
+diff = commit.diff()
+# end diff
+
+# comments list
+comments = gl.project_commit_comments.list(project_id=1, commit_id='master')
+# or
+comments = project.commit_comments.list(commit_id='a5fe4c8')
+# or
+comments = commit.comments.list()
+# end comments list
+
+# comments create
+# Global comment
+commit = commit.comments.create({'note': 'This is a nice comment'})
+# Comment on a line in a file (on the new version of the file)
+commit = commit.comments.create({'note': 'This is another comment',
+                                 'line': 12,
+                                 'line_type': 'new',
+                                 'path': 'README.rst'})
+# end comments create
+
+# statuses list
+statuses = gl.project_commit_statuses.list(project_id=1, commit_id='master')
+# or
+statuses = project.commit_statuses.list(commit_id='a5fe4c8')
+# or
+statuses = commit.statuses.list()
+# end statuses list
+
+# statuses set
+commit.statuses.create({'state': 'success'})
+# end statuses set