diff --git a/CHANGELOG.md b/CHANGELOG.md index 37dcb73dde..a956b22d83 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -38,6 +38,7 @@ - doc: remove update steps in installation instructions and link to maintenance section ([dbf23fa](https://github.com/teslamate-org/teslamate/commit/dbf23faa31d84f222c99dba9f5de52c69dd43afb) and #3794 - @JakobLichterfeld and @brianmay) - doc: add instructions how to update pot files to development guide ([3ab8ee8](https://github.com/teslamate-org/teslamate/commit/3ab8ee8535da32ba0c11307aaacc65379ddcc0b2) - @JakobLichterfeld) - doc: update links to token apps in FAQ (#3833 - @JakobLichterfeld) +- doc: add testing with ci build docker images to contributing guide (#3856- @JakobLichterfeld) ## [1.28.5] - 2024-03-25 diff --git a/website/docs/development.md b/website/docs/development.md index 926a5a42a1..ae79b8e703 100644 --- a/website/docs/development.md +++ b/website/docs/development.md @@ -66,6 +66,26 @@ To ensure a commit passes CI you should run `mix ci` locally, which executes the - Check formatting (`mix format --check-formatted`) - Run all tests (`mix test`) +### Testing with our CI which builds the Docker images automatically per PR + +Our CI automatically builds the Docker images for each PR. To test the changes introduce by a PR you can edit your docker-compose.yml file as follows (replace `pr-3836` with the PR number): + +For TeslaMate: + +```yml +teslamate: + # image: teslamate/teslamate:latest + image: ghcr.io/teslamate-org/teslamate/teslamate:pr-3836 +``` + +For Grafana: + +```yml +grafana: + # image: teslamate/grafana:latest + image: ghcr.io/teslamate-org/teslamate/grafana:pr-3836 +``` + ## Making Changes to Grafana Dashboards To update dashboards you need Grafana running locally. The following _docker-compose.yml_ can be used for this purpose: