Skip to content

Commit dbcfdea

Browse files
authored
README: updating the default.golden file
1 parent eaf8083 commit dbcfdea

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -199,14 +199,17 @@ Downloading demos + running regression tests:
199199

200200
bin/regression-tests.sh
201201

202-
#### Updating `.golden` files
202+
#### Updating the `default.golden` file
203203

204-
The file
204+
The file [`test/default.golden`](https://github.com/markus-wa/demoinfocs-golang/blob/master/test/default.golden) file contains a serialized output of all expected game events in `test/cs-demos/default.dem`.
205205

206-
To update the [`test/default.golden`](https://github.com/markus-wa/demoinfocs-golang/blob/master/test/default.golden) file which contains a serialized output of all expected game events in `test/cs-demos/default.dem` you can run the following command:
206+
If there is a change to game events (new fields etc.) it is necessary to update this file so the regression tests pass.
207+
To update it you can run the following command:
207208

208209
go test -run TestDemoInfoCs -update
209210

211+
Please don't update the `.golden` file if you are not sure it's required. Maybe the failing CI is just pointing out a regression.
212+
210213
### Debugging
211214

212215
You can use the build tag `debugdemoinfocs` (i.e. `go test -tags debugdemoinfocs -v`) to print out debugging information - such as game events or unhandled demo-messages - during the parsing process.<br>

0 commit comments

Comments
 (0)