summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNejc Habjan <hab.nejc@gmail.com>2020-03-22 11:52:59 -0400
committerNejc Habjan <hab.nejc@gmail.com>2020-03-22 11:52:59 -0400
commitda7a809772233be27fa8e563925dd2e44e1ce058 (patch)
treeb9956d3ad1caa4ba8d13a1279701647dbf60171a /docs
parent8c037712a53c1c54e46298fbb93441d9b7a7144a (diff)
downloadgitlab-da7a809772233be27fa8e563925dd2e44e1ce058.tar.gz
feat: add support for commit GPG signature API
Diffstat (limited to 'docs')
-rw-r--r--docs/cli.rst12
-rw-r--r--docs/gl_objects/commits.rst4
2 files changed, 16 insertions, 0 deletions
diff --git a/docs/cli.rst b/docs/cli.rst
index 3207902..b4a6c5e 100644
--- a/docs/cli.rst
+++ b/docs/cli.rst
@@ -236,6 +236,18 @@ Create a snippet:
$ gitlab project-snippet create --project-id 2 --title "the title" \
--file-name "the name" --code "the code"
+Get a specific project commit by its SHA id:
+
+.. code-block:: console
+
+ $ gitlab project-commit get --project-id 2 --id a43290c
+
+Get the GPG signature of a signed commit:
+
+.. code-block:: console
+
+ $ gitlab project-commit signature --project-id 2 --id a43290c
+
Define the status of a commit (as would be done from a CI tool for example):
.. code-block:: console
diff --git a/docs/gl_objects/commits.rst b/docs/gl_objects/commits.rst
index abfedc8..e6bdfd8 100644
--- a/docs/gl_objects/commits.rst
+++ b/docs/gl_objects/commits.rst
@@ -82,6 +82,10 @@ Get the references the commit has been pushed to (branches and tags)::
commit.refs('tag') # only tags
commit.refs('branch') # only branches
+Get the GPG signature of the commit (if the commit was signed)::
+
+ commit.signature()
+
List the merge requests related to a commit::
commit.merge_requests()