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
|
#######
Commits
#######
Commits
=======
Reference
---------
* v4 API:
+ :class:`gitlab.v4.objects.ProjectCommit`
+ :class:`gitlab.v4.objects.ProjectCommitManager`
+ :attr:`gitlab.v4.objects.Project.commits`
Examples
--------
List the commits for a project::
commits = project.commits.list()
You can use the ``ref_name``, ``since`` and ``until`` filters to limit the
results::
commits = project.commits.list(ref_name='my_branch')
commits = project.commits.list(since='2016-01-01T00:00:00Z')
Create a commit::
# See https://docs.gitlab.com/ce/api/commits.html#create-a-commit-with-multiple-files-and-actions
# for actions detail
data = {
'branch_name': 'master', # v3
'branch': 'master', # v4
'commit_message': 'blah blah blah',
'actions': [
{
'action': 'create',
'file_path': 'README.rst',
'content': open('path/to/file.rst').read(),
},
{
# Binary files need to be base64 encoded
'action': 'create',
'file_path': 'logo.png',
'content': base64.b64encode(open('logo.png').read()),
'encoding': 'base64',
}
]
}
commit = project.commits.create(data)
Get a commit detail::
commit = project.commits.get('e3d5a71b')
Get the diff for a commit::
diff = commit.diff()
Cherry-pick a commit into another branch::
commit.cherry_pick(branch='target_branch')
Commit comments
===============
Reference
---------
* v4 API:
+ :class:`gitlab.v4.objects.ProjectCommitComment`
+ :class:`gitlab.v4.objects.ProjectCommitCommentManager`
+ :attr:`gitlab.v4.objects.Commit.comments`
* GitLab API: https://docs.gitlab.com/ce/api/commits.html
Examples
--------
Get the comments for a commit::
comments = commit.comments.list()
Add a comment on a commit::
# 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'})
Commit status
=============
Reference
---------
* v4 API:
+ :class:`gitlab.v4.objects.ProjectCommitStatus`
+ :class:`gitlab.v4.objects.ProjectCommitStatusManager`
+ :attr:`gitlab.v4.objects.Commit.statuses`
* GitLab API: https://docs.gitlab.com/ce/api/commits.html
Examples
--------
List the statuses for a commit::
statuses = commit.statuses.list()
Change the status of a commit::
commit.statuses.create({'state': 'success'})
|
