Skip to content

Custom branding for cloud clients

The Repo Bot procedure below was written for V14 and has not been re-verified against the current version. The theme guide it used to point to (app/frontend/src/shared/stylesheets/easy/themes/README.md) no longer exists. For the current branding steps (assets, _theme--brand.scss, fonts, colours) see Theme and custom branding.

Custom branding lives in the modification plugin of each client, so prepare that structure first, then follow the theme guide linked above.

Repository preparation

Repo Bot actions live in GitLab. When the pipeline passes, the changes appear in the client's repository as a merge request from a branch starting with repo-bot.

Each client with custom branding must have the CI variable HAS_CUSTOM_BRANDING set to true in the repository.

  1. In ESko, find the client's contract ID (https://es.easy8.com/easy_contracts/<ID>). It is referred to as CONTRACT_ID below.

  2. If the client repository does not exist, run the create-repository pipeline with CONTRACT_ID. The pipeline log ends with the repository URL, for example [RepoBot::Services::Cli::CreateRepository] New project is ready on https://git.easy8.com/clients/my_little_pony.

  3. Run the add-custom-branding pipeline with CONTRACT_ID. It:

    • creates the CI variable HAS_CUSTOM_BRANDING, so later updates do not delete changes in app/frontend/src/shared/stylesheets/easy/themes/_theme--brand.scss;
    • creates the modification plugin with the branding directories and files, or extends the existing plugin with them.