-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add building and Makefile usage sections
Signed-off-by: Hank Donnay <hdonnay@redhat.com>
- Loading branch information
Showing
4 changed files
with
22 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,6 @@ | ||
# Contribuion | ||
The following sections provides information on how to contribute to Clair. | ||
|
||
- [Building](./contribution/building.md) | ||
- [Commit Style](./contribution/commit_style.md) | ||
- [Releases](./contribution/releases.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Building | ||
|
||
This repo is intended to be built with familiar `go build` or `go install` invocations. | ||
All binaries (excepting debugging tools) are underneath the `cmd` directory. | ||
|
||
### Cross-compiling | ||
|
||
Currently Clair does not have any cgo dependencies, so there should not be any cross-compilation concerns. | ||
|
||
## Container | ||
|
||
A `Dockerfile` for the project is in the repo root. | ||
**The only upstream-supported means of using it is Buildkit via `buildctl`.** | ||
See the `container`, `container-build`, `dist-container`, and `dist-clairctl` make targets for example invocations. | ||
The `BUILDKIT_HOST` environment variable may need to be set, depending on how `buildkitd` is running in one's environment. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters