Skip to content

Latest commit

 

History

History
137 lines (67 loc) · 3.24 KB

build-env.md

File metadata and controls

137 lines (67 loc) · 3.24 KB
Raw

BUILD ENV

The BUILD ENV instruction tells the layerfile to rebuild when a variable changes.

Examples

  • Commonly used with $SUBDOMAIN to ensure each branch has the proper value:
BUILD ENV SUBDOMAIN
RUN echo "HOST=$SUBDOMAIN.mydomain.com" >> .env
RUN docker-compose up -d

Possible values

SUBDOMAIN

SUBDOMAIN=my-branch

The SUBDOMAIN variable is often used to set the HOST variable for webservers.

It is a cleaned up version of the $LAYERCI_BRANCH variable, acceptable for use in a URL.

  • feat/add-some-dashboard-pages becomes add-some-dashboard-pages

Common use is to set HOST=$SUBDOMAIN.demo.example.com

CI

CI=true, IS_CI_MACHINE=true, CI_MACHINE=true, IN_CI_MACHINE=true, IN_CI=true

These CI variables are always true in LayerCI.

GIT_TAG

GIT_TAG=v1.0.0

GIT_TAG is the result of running git describe --always in the repository.

GIT_COMMIT

GIT_COMMIT=111122223333444455556666777788889999aaaa

GIT_COMMIT is the result of running git rev-parse HEAD in the repository.

GIT_COMMIT_TITLE

GIT_COMMIT_TITLE="[improvement] do something"

GIT_CLONE_USER

GIT_CLONE_USER=x-access-token:<token>

GIT_CLONE_URL is a token which can be used to clone this repository. git clone https://$GIT_CLONE_USER@github.com/org/repo.git

EXPOSE_WEBSITE_HOST

EXPOSE_WEBSITE_HOST=(uuid).cidemo.co

EXPOSE_WEBSITE_HOST is the hostname exposed by EXPOSE WEBSITE

It's often used to link a frontend with a backend when running both with EXPOSE WEBSITE and RUN BACKGROUND

You can even reference this before EXPOSE WEBSITE is ever used, but the URL is only live after the run passes.

Note: Unavailable for use by BUILD ENV

LAYERCI

LAYERCI=true

LAYERCI is always true in LayerCI test runs.

LAYERCI_BRANCH

LAYERCI_BRANCH=staging

LAYERCI_BRANCH is included if this commit was to a specific branch in the repository. LAYERCI_BRANCH is not included if this job is running due to an external pull request.

LAYERCI_JOB_ID

LAYERCI_JOB_ID=5

LAYERCI_JOB_ID always exists. It's set to the ID of the current running job.

LAYERCI_PULL_REQUEST

LAYERCI_PULL_REQUEST=https://github.com/some/repo/pull_requests/5

LAYERCI_PULL_REQUEST may or may not exist. It's a link to the pull request that triggered this pipeline.

LAYERCI_REPO_NAME

LAYERCI_REPO_NAME=somerepo

LAYERCI_REPO_NAME is the name of the repository. If the repository is at github.com/a/b, this would be "b"

LAYERCI_REPO_OWNER

LAYERCI_REPO_OWNER=repoowner

LAYERCI_REPO_OWNER is the name of the owner of this repository. If the repository is at github.com/a/b, this would be "a"

LAYERCI_ORG_NAME

LAYERCI_ORG_NAME=myorg

LAYERCI_ORG_NAME is the name of the current organization. If the dashboard is at layerci.com/myorg, this would be "myorg"

LAYERCI_RUNNER_ID

LAYERCI_RUNNER_ID=main-layerfile

LAYERCI_RUNNER_ID is the id of the current layerfile runner.

RETRY_INDEX

RETRY_INDEX=1

RETRY_INDEX is the current retry for the given runner (initially 1, then when retried once, 2, etc)

API_EXTRA

API_EXTRA=some data passed from API

API_EXTRA is optional data passed in when a run is started by the API.