You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+42-3
Original file line number
Diff line number
Diff line change
@@ -8,8 +8,6 @@ A Grafana backend plugin that handles rendering panels and dashboards to PNGs us
8
8
- Windows (x64)
9
9
- Mac OS X (x64)
10
10
11
-
For Mac ARM64, you need to [build the plugin from source](https://github.com/grafana/grafana-image-renderer/blob/master/docs/building_from_source.md) or use the [remote rendering installation](https://github.com/grafana/grafana-image-renderer?tab=readme-ov-file#remote-rendering-service-installation).
12
-
13
11
### Dependencies
14
12
15
13
This plugin is packaged in a single executable with [Node.js](https://nodejs.org/) runtime and [Chromium browser](https://www.chromium.org/Home).
@@ -134,4 +132,45 @@ For available configuration settings, please refer to [Grafana Image Rendering d
In order to run the image-renderer automated test suites, you need to run the following command from the root folder:
140
+
141
+
```
142
+
yarn test
143
+
```
144
+
145
+
This will launch a Grafana instance in Docker and, then, run the test suites.
146
+
147
+
_Notes:_
148
+
149
+
If there are some expected changes in the reference image files (located in`/tests/testdata`), run `yarn test-update` and push the updated references.
150
+
151
+
If the tests are failing and you want to see the difference between the image you get and the reference image, run `yarn test-diff`. This will generate images (called `diff_<test case>.png`) containing the differences in the `/tests/testdata` folder.
152
+
153
+
### Fixing Drone issues
154
+
155
+
If tests are successful in your local environement but fail in Drone. You can follow these steps to run the tests in an environment similar to the Drone pipeline. This will mount your local files of the `grafana-image-renderer` repo in the Docker image so any change that happens in the Docker image will be available in your local environment. This allows you to run `yarn test-diff` and `yarn test-update`in Docker and see the results locally.
156
+
157
+
1. Run the Drone environment in Docker:
158
+
159
+
```
160
+
cd ./devenv/docker/drone
161
+
docker-compose up
162
+
```
163
+
164
+
2. Open a terminal within the `drone-docker-puppeteer` container and run the following commands:
0 commit comments