Skip to content

Commit

Permalink
Added a list of the prerequisites for running portage locally
Browse files Browse the repository at this point in the history
  • Loading branch information
sflanker committed Sep 20, 2024
1 parent 42f03ba commit 1d97b1b
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,15 @@ Install Prerequisites:
- Golang >= v1.22.0
- [Just](https://github.com/casey/just?tab=readme-ov-file#installation) (optional)

Prerequisite Tools (For running `portage` local)

- Gitleaks
- Semgrep
- Syft
- Grype
- ClamAV (only the `clamscan` and `freshclam` cli utilities are needed)
- ORAS

## Compiling Portage CD

Running the just recipe will put the compiled-binary into `./bin`
Expand All @@ -36,7 +45,7 @@ mkdir bin
go build -o bin/portage ./cmd/portage
```

Optionally, if you care to include metadata you use build arguments
Optionally, if you care to include metadata about the version of `portage` (displayed when you run `portage version`), use the following build arguments

```shell
go build -ldflags="-X 'main.cliVersion=$(git describe --tags)' -X 'main.gitCommit=$(git rev-parse HEAD)' -X 'main.buildDate=$(date -u +%Y-%m-%dT%H:%M:%SZ)' -X 'main.gitDescription=$(git log -1 --pretty=%B)'" -o ./bin ./cmd/portage
Expand Down

0 comments on commit 1d97b1b

Please sign in to comment.