docs: describe the CI workflows and make ci
This commit is contained in:
parent
65528830d3
commit
64b7614db1
1 changed files with 9 additions and 0 deletions
|
|
@ -109,12 +109,21 @@ It is served on the API listener together with `/api`, so it needs no CORS, and
|
|||
make admin # npm ci && npm run build
|
||||
make build # go build, embeds the UI
|
||||
make test # go test + vitest
|
||||
make ci # what CI runs: gofmt, vet, race tests, frontend tests and build
|
||||
make e2e # end-to-end with a real Postfix in Docker (about 2 minutes, mostly the image build)
|
||||
```
|
||||
|
||||
Without `make admin` the binary still builds and the UI answers 503 with a hint.
|
||||
For frontend work run the daemon, then `cd admin && npm run dev` (Vite proxies `/api` to `127.0.0.1:8080`).
|
||||
|
||||
## Continuous integration
|
||||
|
||||
`.forgejo/workflows/ci.yaml` runs on Forgejo Actions (Codeberg) for pushes to `main` and for pull requests:
|
||||
a Go job (`make go-ci`: gofmt, `go vet`, tests with the race detector) and an admin UI job (`make admin-ci`:
|
||||
`npm ci`, tests, type check, build). Enable Actions in the repository settings and provide a runner with the
|
||||
`docker` label (change `runs-on` if yours is named differently). `make ci` does the same locally.
|
||||
`.forgejo/workflows/e2e.yaml` runs the Postfix end-to-end test on demand, because it needs a runner that can run Docker.
|
||||
|
||||
## End-to-end test
|
||||
|
||||
`make e2e` starts a real Postfix and parsimony in Docker and walks the whole path: Postfix hands list mail to
|
||||
|
|
|
|||
Loading…
Reference in a new issue