Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-docs.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcel Amirault <mamirault@gitlab.com>2021-09-02 12:07:46 +0300
committerMarcel Amirault <mamirault@gitlab.com>2021-09-02 12:07:46 +0300
commit2f94ff532be55c838e455b6020b22d0a08f202e4 (patch)
treead7a0a7198f5097125f8f19642817de1280a09cd /doc/maintenance.md
parent8ed926e5fca7f31b7db5375338055eaefcab4b66 (diff)
Add details about our tokens
Diffstat (limited to 'doc/maintenance.md')
-rw-r--r--doc/maintenance.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/maintenance.md b/doc/maintenance.md
index 92596e3f..1bbe3cd8 100644
--- a/doc/maintenance.md
+++ b/doc/maintenance.md
@@ -113,3 +113,19 @@ it with:
To test that the CSP header works as expected, you can visit
<https://cspvalidator.org/> and paste the URL that you want tested.
+
+## Project tokens
+
+The `gitlab-docs` project has two access tokens used for review apps. If you change
+or delete these tokens, review apps will stop working:
+
+- `DOCS_TRIGGER_TOKEN` is a [trigger token](https://docs.gitlab.com/ee/ci/triggers/index.html#trigger-token).
+ This token is used by other projects to authenticate with the `gitlab-docs` project
+ and trigger a review app deployment pipeline.
+- `DOCS_PROJECT_API_TOKEN` is a [project access token](https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html).
+ This token is used by other projects to poll the review app deployment pipeline
+ and determine if the pipeline has completed successfully.
+
+All projects that have documentation review apps use these tokens when running the
+[`trigger-build` script](https://gitlab.com/gitlab-org/gitlab/-/blob/b09be454102f4d53ec7963aef8a625daf8ef6acc/scripts/trigger-build#L207)
+to deploy a review app.