From 475661d8aba4b8ebbf4c4aaa85407eabd88cf24e Mon Sep 17 00:00:00 2001
From: Sydney Anne Erickson <sydney@elixxir.io>
Date: Wed, 13 Jul 2022 19:41:42 +0000
Subject: [PATCH] Add a docstring to the CI job
---
.gitlab-ci.yml | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index acf4c6915..5d5bbe80f 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -120,11 +120,18 @@ bindings-android:
- bindings.aar
- bindings-sources.jar
+# This pipeline job will attempt to have pkg.go.dev update docs for client/xxdk.
+#
+# pkg.go.dev relies on the proxy.golang.org service (go module cache/proxy) to discover versions of
+# Go modules to make docs of. The proxy keeps a list of all known versions of Go modules. The go
+# mod proxy does cache pulls for about 30 minutes, so if quickly successive commits are done in
+# master/release, this will fail to pull the latest client, and the docs will not update.
trigger-doc-update:
stage: trigger_integration
image: $DOCKER_IMAGE
script:
- - go install gitlab.com/elixxir/client@$CI_COMMIT_REF_NAME
+ # We use GOPRIVATE blank because not want to directly pull client, we want to use the public cache.
+ - GOPRIVATE="" go install gitlab.com/elixxir/client@$CI_COMMIT_REF_NAME
only:
- release
- master
--
GitLab