summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axil@gitlab.com>2018-12-21 12:01:50 +0100
committerAchilleas Pipinellis <axil@gitlab.com>2019-01-04 13:34:49 +0100
commit85157165bad28f3be33bf2982eab9c7ebd49e3d2 (patch)
tree3fcb6d6448674d98c9d52357e930d73bafe0d062
parent833276cd2a12eafef555f131dbcf0f64fa687d09 (diff)
downloadgitlab-ce-docs/autodevops-buildpacks.tar.gz
Clarify needed app files for Auto Build to workdocs/autodevops-buildpacks
Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/45279
-rw-r--r--doc/topics/autodevops/index.md37
1 files changed, 30 insertions, 7 deletions
diff --git a/doc/topics/autodevops/index.md b/doc/topics/autodevops/index.md
index e937d372384..a96dd6aa9f0 100644
--- a/doc/topics/autodevops/index.md
+++ b/doc/topics/autodevops/index.md
@@ -284,21 +284,44 @@ to understand how each one works.
### Auto Build
-Auto Build creates a build of the application in one of two ways:
-
-- If there is a `Dockerfile`, it will use `docker build` to create a Docker image.
-- Otherwise, it will use [Herokuish](https://github.com/gliderlabs/herokuish)
- and [Heroku buildpacks](https://devcenter.heroku.com/articles/buildpacks)
- to automatically detect and build the application into a Docker image.
+Auto Build creates a build of the application using an existing `Dockerfile` or
+Heroku buildpacks.
Either way, the resulting Docker image is automatically pushed to the
[Container Registry][container-registry] and tagged with the commit SHA.
-CAUTION: **Important:**
+#### Auto Build using a Dockerfile
+
+If a project's repository contains a `Dockerfile`, Auto Build will use
+`docker build` to create a Docker image.
+
If you are also using Auto Review Apps and Auto Deploy and choose to provide
your own `Dockerfile`, make sure you expose your application to port
`5000` as this is the port assumed by the default Helm chart.
+#### Auto Build using Heroku buildpacks
+
+Auto Build builds an application using a project's `Dockerfile` if present, or
+otherwise it will use [Herokuish](https://github.com/gliderlabs/herokuish)
+and [Heroku buildpacks](https://devcenter.heroku.com/articles/buildpacks)
+to automatically detect and build the application into a Docker image.
+
+Each buildpack requires certain files to be in your project's repository for
+Auto Build to successfully build your application. For example, the following
+files are required at the root of your application's repository, depending on
+the language:
+
+- A `Pipfile` or `requirements.txt` file for Python projects.
+- A `Gemfile` or `Gemfile.lock` file for Ruby projects.
+
+For the requirements of other languages and frameworks, read the
+[buildpacks docs](https://devcenter.heroku.com/articles/buildpacks#officially-supported-buildpacks).
+
+TIP: **Tip:**
+If Auto Build fails despite the project meeting the buildpack requirements, set
+a project variable `TRACE=true` to enable verbose logging, which may help to
+troubleshoot.
+
### Auto Test
Auto Test automatically runs the appropriate tests for your application using