Merge branch 'eread/add-ability-to-create-review-apps-by-using-gitlab-docs-hugo-project' into 'main'

Add ability to create review apps by using the GitLab Docs Hugo project

See merge request https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/5205

Merged-by: Russell Dickenson <[email protected]>
Approved-by: Russell Dickenson <[email protected]>
Co-authored-by: Achilleas Pipinellis <[email protected]>
Co-authored-by: Evan Read <[email protected]>

Author: 3 people

.gitlab/ci/docs.gitlab-ci.yml

@@ -71,7 +71,7 @@ docs:check Kubernetes API docs:
   before_script:
   - gem install gitlab --no-doc
   # We need to download the script rather than clone the repo since the
-  # review-docs-cleanup job will not be able to run when the branch gets
+  # review-docs-cleanup and review-docs-hugo-cleanup jobs will not be able to run when the branch gets
   # deleted (when merging the MR).
   - apk add --update openssl
   - wget https://gitlab.com/gitlab-org/gitlab/-/raw/master/scripts/trigger-build.rb
@@ -85,7 +85,7 @@ docs:check Kubernetes API docs:
 
 # Trigger a docs build in gitlab-docs
 # Useful to preview the docs changes live
-# https://docs.gitlab.com/ee/development/documentation/index.html#previewing-the-changes-live
+# https://docs.gitlab.com/ee/development/documentation/review_apps.html
 review-docs-deploy:
   extends:
   - .review-docs
@@ -108,3 +108,27 @@ review-docs-cleanup:
     action: stop
   script:
   - ./trigger-build.rb docs cleanup
+
+# Trigger a docs build in gitlab-docs-hugo
+# Useful to preview the docs changes live
+# https://docs.gitlab.com/ee/development/documentation/review_apps.html
+review-docs-hugo-deploy:
+  extends:
+  - .review-docs
+  environment:
+    name: review-docs/mr-${CI_MERGE_REQUEST_IID}-hugo
+    auto_stop_in: 2 weeks
+    url: https://new.docs.gitlab.com/upstream-review-mr-${DOCS_GITLAB_REPO_SUFFIX}-${CI_MERGE_REQUEST_IID}/${DOCS_GITLAB_REPO_SUFFIX}
+    on_stop: review-docs-hugo-cleanup
+  script:
+  - ./trigger-build.rb docs-hugo deploy
+
+# Cleanup remote environment of gitlab-docs-hugo
+review-docs-hugo-cleanup:
+  extends:
+  - .review-docs
+  environment:
+    name: review-docs/mr-${CI_MERGE_REQUEST_IID}-hugo
+    action: stop
+  script:
+  - ./trigger-build.rb docs-hugo cleanup

docs/executors/ssh.md

@@ -12,7 +12,7 @@ DETAILS:
 
 NOTE:
 The SSH executor supports only scripts generated in Bash and the caching feature
-is currently not supported.
+is not supported.
 
 This is a simple executor that allows you to execute builds on a remote machine
 by executing commands over SSH.