Merge pull request #768 from python-gitlab/trigger_token_example

max-wittig · web-flow · commit 5af0b527a44d · 2019-06-08T17:22:09.000+02:00
docs: Add an example of trigger token usage
diff --git a/docs/gl_objects/builds.rst b/docs/gl_objects/builds.rst
@@ -94,6 +94,16 @@ Full example with wait for finish::
         pipeline.refresh()
         time.sleep(1)
 
+You can trigger a pipeline using token authentication instead of user
+authentication. To do so create an anonymous Gitlab instance and use lazy
+objects to get the associated project::
+
+    gl = gitlab.Gitlab(URL)  # no authentication
+    project = gl.projects.get(project_id, lazy=True)  # no API call
+    project.trigger_pipeline('master', trigger_token)
+
+Reference: https://docs.gitlab.com/ee/ci/triggers/#trigger-token
+
 Pipeline schedule
 =================
 
