particle-os/debian-forge-composer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

test/README: run go tests when updating images

Browse source 
Add a small paragraph with the instruction to run the go tests when
pulling in a new version of images as a guide for making sure that
osbuild-composer builds and runs successfully, before moving on to
integration tests.
This commit is contained in:
Achilleas Koutsou 2023-10-26 20:46:22 +02:00
parent 81240f58ba
commit 61aea1a06f
1 changed files with 14 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

16
test/README.md
View file

@ -75,8 +75,20 @@ go mod edit -replace github.com/osbuild/images=github.com/<username>/images@<com
./tools/prepare-source.sh
```
This will allow you to open a test PR and run the osbuild-composer integration
tests against your updated code.
Using the URL of the remote fork and branch will allow you to open a test PR
and run the osbuild-composer integration tests against your updated code.
Make sure you modify any code in osbuild-composer to adapt to the changes in
the images repository. The images API is not considered stable and changes can
occur frequently. A good quick check that everything compiles and _mostly_ runs
correctly is by running the unit tests:
```
go test ./...
```
and some static checks:
```
go vet ./...
```
The changes to the `go.mod`, `go.sum`, and `vendor/` directory should be added
in a separate commit from any other changes. The PR should not be merged with