Use alpine image in GitLab Ci README example

docat-org · Oct 17, 2021 · a70d401 · a70d401
1 parent 990553a
commit a70d401
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -83,7 +83,7 @@ Use the following Job template to publish the docs:
 
 ```yaml
 deploy-docs:
-  image: ghcr.io/docat-org/docatl:latest
+  image: ghcr.io/docat-org/docatl:latest-alpine
   variables:
     DOCATL_HOST: https://docat.company.io
     DOCATL_API_KEY: blabla
@@ -97,7 +97,7 @@ Automatically tag with `latest`:
 
 ```yaml
 deploy-docs:
-  image: ghcr.io/docat-org/docatl:latest
+  image: ghcr.io/docat-org/docatl:latest-alpine
   variables:
     DOCATL_HOST: https://docat.company.io
     DOCATL_API_KEY: blabla
@@ -107,6 +107,8 @@ deploy-docs:
     - push ./docs --tag latest
 ```
 
+Note: you must use the `-alpine` variant on the container image, because GitLab Ci needs a shell.
+
 ## Configuration
 
 You can configure `docatl` with either command line arguments, env variables and/or a config file (evaluated in that order of precedence).