integrations/docker/images/chip-build-cirque/README.md

   1 # Docker connectedhomeip:chip-build-cirque
   2
   3 connectedhomeip/chip-build-cirque is the name of the Docker image used by CHIP
   4 for continuous integration and other builds when using Cirque. It builds upon
   5 the chip-build image and adds system dependencies needed by Cirque.
   6
   7 Contents of this directory:
   8
   9 -   build.sh - utility for building (and optionally) tagging and pushing the
  10     chip-build Docker image
  11 -   version - the semver-style version of the image in use for this branch of
  12     CHIP
  13 -   Dockerfile - description of the image
  14
  15 Please update version when any required tooling is updated. Some rough
  16 guidelines:
  17
  18 -   Updating a tool? Increment dot version unless the tool has a major version
  19     delta or a backward incompatibility
  20 -   Adding a tool? Increment minor version: e.g. 0.2.1 -> 0.3.0
  21 -   Removing a tool? Increment major version: e.g. 1.2 -> 2.0
  22
  23 Note, you must have privileged access to the connectedhomeip area on Docker Hub
  24 to push the image.
  25
  26 Typical use:
  27
  28 1.  new build tool dependency identified
  29 2.  add tool to Dockerfile
  30 3.  update version
  31 4.  `$ ./build.sh`, which installs the image locally as the new version
  32 5.  update the image version in the devcontainer.json and CI manifests
  33 6.  verify that the build works locally in the new image
  34 7.  `$ docker login`
  35 8.  `$ ./build.sh --push --latest`, _*Note:*_ omit `--latest` unless on the
  36     master branch