Skip to content

Commit d6895a2

Browse files
committed
docs: added devspacehelper build details
1 parent 4aadfe7 commit d6895a2

1 file changed

Lines changed: 18 additions & 7 deletions

File tree

CONTRIBUTING.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,24 @@ This project is mainly written in Golang. To contribute code,
2020
5. Run `go clean -modcache`
2121
6. Run `go mod vendor` to update the dependencies
2222
7. Build the project, e.g. via `go build -o devspace.exe`
23-
8. Make changes
24-
9. Run unit tests: `./hack/coverage.bash`
25-
10. Run E2E tests: `cd e2e/ && go test -v -ginkgo.v`
26-
11. Format your code: `go fmt ./...`
27-
12. Commit changes *([Please refer the commit message conventions](https://www.conventionalcommits.org/en/v1.0.0/))*
28-
13. Push commits
29-
14. Open pull request
23+
8. Build devspacehelper using below command
24+
```
25+
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags "-extldflags=-static" -o ~/.devspace/devspacehelper/latest/devspacehelper helper/main.go
26+
chmod +x ~/.devspace/devspacehelper/latest/devspacehelper
27+
```
28+
The above command is required to be executed as sometimes you may observe below error,
29+
```
30+
start_dev: error setting up proxy commands in container: Internal error occurred: error executing command in container: failed to exec in container: failed to start exec "38d5fc79b8a7c63d38ba5f99237d80df186871fa4b43987a83a926628d1c47e1": OCI runtime exec failed: exec failed: unable to start container process: exec /tmp/devspacehelper: text file busy: unknown
31+
```
32+
33+
34+
9. Make changes
35+
10. Run unit tests: `./hack/coverage.bash`
36+
11. Run E2E tests: `cd e2e/ && go test -v -ginkgo.v`
37+
12. Format your code: `go fmt ./...`
38+
13. Commit changes *([Please refer the commit message conventions](https://www.conventionalcommits.org/en/v1.0.0/))*
39+
14. Push commits
40+
15. Open pull request
3041
3142
## Improving the Documentation
3243
The documentation is contained within `./docs` and made with Docusaurus. See the [Docs README](./docs) for infos about developing the docs.

0 commit comments

Comments
 (0)