baalajimaestro/traefik
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

docs(contributing): enhance wording of building-testing page

Browse source
This commit is contained in:
sven 2022-11-15 19:34:04 +01:00 committed by GitHub
parent 00de5c711a
commit 35d8281f4d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/content/contributing/building-testing.md
View file

@ -8,17 +8,22 @@ description: "Compile and test your own Traefik Proxy! Learn how to build your o
Compile and Test Your Own Traefik! Compile and Test Your Own Traefik!
{: .subtitle } {: .subtitle }
So you want to build your own Traefik binary from the sources? You want to build your own Traefik binary from the sources?
Let's see how. Let's see how.
## Building ## Building
You need either [Docker](https://github.com/docker/docker) and `make` (Method 1), or `go` (Method 2) in order to build Traefik. You need either [Docker](https://github.com/docker/docker "Link to website of Docker") and `make` (Method 1), or [Go](https://go.dev/ "Link to website of Go") (Method 2) in order to build Traefik.
For changes to its dependencies, the `dep` dependency management tool is required. For changes to its dependencies, the `dep` dependency management tool is required.
### Method 1: Using `Docker` and `Makefile` ### Method 1: Using `Docker` and `Makefile`
Run make with the `binary` target. Run make with the `binary` target.
```bash
make binary
```
This will create binaries for the Linux platform in the `dist` folder. This will create binaries for the Linux platform in the `dist` folder.
In case when you run build on CI, you may probably want to run docker in non-interactive mode. To achieve that define `DOCKER_NON_INTERACTIVE=true` environment variable. In case when you run build on CI, you may probably want to run docker in non-interactive mode. To achieve that define `DOCKER_NON_INTERACTIVE=true` environment variable.
@ -160,7 +165,7 @@ TESTFLAGS="-check.f MyTestSuite.My" make test-integration
TESTFLAGS="-check.f MyTestSuite.*Test" make test-integration TESTFLAGS="-check.f MyTestSuite.*Test" make test-integration
``` ```
More: https://labix.org/gocheck Check [gocheck](https://labix.org/gocheck "Link to website of gocheck") for more information.
### Method 2: `go` ### Method 2: `go`