Commit 5d69ea26 authored by Vincent Tunru's avatar Vincent Tunru

Use consistent URLs for review apps in the docs

It said `<slug>.review.example.com` at one place,
`review-<slug>.example.com` elsewhere, and no mention of `review`
at all in other places. We now leave out `review` everywhere.
parent 111e17e3
...@@ -297,7 +297,7 @@ deploy_review: ...@@ -297,7 +297,7 @@ deploy_review:
- echo "Deploy a review app" - echo "Deploy a review app"
environment: environment:
name: review/$CI_BUILD_REF_NAME name: review/$CI_BUILD_REF_NAME
url: https://$CI_ENVIRONMENT_SLUG.review.example.com url: https://$CI_ENVIRONMENT_SLUG.example.com
only: only:
- branches - branches
except: except:
...@@ -318,15 +318,15 @@ also contain `/`, or other characters that would be invalid in a domain name or ...@@ -318,15 +318,15 @@ also contain `/`, or other characters that would be invalid in a domain name or
URL, we use `$CI_ENVIRONMENT_SLUG` in the `environment:url` so that the URL, we use `$CI_ENVIRONMENT_SLUG` in the `environment:url` so that the
environment can get a specific and distinct URL for each branch. In this case, environment can get a specific and distinct URL for each branch. In this case,
given a `$CI_BUILD_REF_NAME` of `100-Do-The-Thing`, the URL will be something given a `$CI_BUILD_REF_NAME` of `100-Do-The-Thing`, the URL will be something
like `https://review-100-do-the-4f99a2.example.com`. Again, the way you set up like `https://100-do-the-4f99a2.example.com`. Again, the way you set up
the web server to serve these requests is based on your setup. the web server to serve these requests is based on your setup.
You could also use `$CI_BUILD_REF_SLUG` in `environment:url`, e.g.: You could also use `$CI_BUILD_REF_SLUG` in `environment:url`, e.g.:
`https://$CI_BUILD_REF_SLUG.review.example.com`. We use `$CI_ENVIRONMENT_SLUG` `https://$CI_BUILD_REF_SLUG.example.com`. We use `$CI_ENVIRONMENT_SLUG`
here because it is guaranteed to be unique, but if you're using a workflow like here because it is guaranteed to be unique, but if you're using a workflow like
[GitLab Flow][gitlab-flow], collisions are very unlikely, and you may prefer [GitLab Flow][gitlab-flow], collisions are very unlikely, and you may prefer
environment names to be more closely based on the branch name - the example environment names to be more closely based on the branch name - the example
above would give you an URL like `https://100-do-the-thing.review.example.com` above would give you an URL like `https://100-do-the-thing.example.com`
Last but not least, we tell the job to run [`only`][only] on branches Last but not least, we tell the job to run [`only`][only] on branches
[`except`][only] master. [`except`][only] master.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment