3pp-mirror/pomerium
1
0
Fork 0
mirror of https://github.com/pomerium/pomerium.git synced 2025-07-30 06:51:30 +02:00
Code Issues Projects Releases Packages Wiki Activity

update README: link to Contributing page (#5072)

Browse source 
Remove the inline integration test instructions in favor of a link to
the Contributing page on the documentation site. Remove some unused link
definitions and update the godoc.org link to use pkg.go.dev instead.
This commit is contained in:
Kenneth Jenkins 2024-04-15 14:03:38 -07:00 • committed by GitHub
parent f03b1cd9ff
commit 1aa062b37b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -19,34 +19,10 @@ It’s not a VPN alternative – it’s the trusted, foolproof way to protect yo
For comprehensive docs, and tutorials see our [documentation].
[documentation]: https://pomerium.com/docs/
[go environment]: https://golang.org/doc/install
[godocs]: https://godoc.org/github.com/pomerium/pomerium
[quick start guide]: https://www.pomerium.com/docs/install/quickstart
## Contributing
## Integration Tests
See [Contributing] for information on how you can contribute to Pomerium.
To run the integration tests locally, first build a local development image:
```bash
./scripts/build-dev-docker.bash
```
Next go to the `integration/clusters` folder and pick a cluster, for example `google-single`, then use docker-compose to start the cluster. We use an environment variable to specify the `dev` docker image we built earlier:
```bash
cd integration/clusters/google-single
env POMERIUM_TAG=dev docker-compose up -V
```
Once that's up and running you can run the integration tests from another terminal:
```bash
go test -count=1 -v ./integration/...
```
If you need to make a change to the clusters themselves, there's a `tpl` folder that contains `jsonnet` files. Make a change and then rebuild the clusters by running:
```bash
go run ./integration/cmd/pomerium-integration-tests/ generate-configuration
```
[contributing]: https://www.pomerium.com/docs/community/contributing
[documentation]: https://www.pomerium.com/docs/
[godocs]: https://pkg.go.dev/github.com/pomerium/pomerium