Skip to content

Commit 857cb68

Browse files
authored
Add build instructions and installation guide (#172)
Fixes #65 - Add build targets to Makefile and Installation section to README with build instructions, prerequisites, and usage examples. Signed-off-by: yxxhero <aiopsclub@163.com>
1 parent 83a7c41 commit 857cb68

File tree

2 files changed

+53
-0
lines changed

2 files changed

+53
-0
lines changed

Makefile

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@ test:
66
test/verbose:
77
RETAIN_TEMP_DIR=1 go test -v ./...
88

9+
.PHONY: build
10+
build:
11+
go build -o chartify ./cmd/chartify
12+
13+
.PHONY: build/chartreposerver
14+
build/chartreposerver:
15+
go build -o chartreposerver ./cmd/chartreposerver
16+
917
.PHONY: act
1018
act:
1119
act

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,40 @@
66

77
`chartify` is intended to be run immediately before running `helm upgrade --install`. For example, instead of forking a helm chart, you should be able to prepend a `chartify` step into your deployment job in your CD pipeline. `chartify` isn't intended to create a fork of a chart. The output of `chartify` is a helm chart that is pre-rendered with all the helm values provided to `chartify`.
88

9+
## Installation
10+
11+
### Build from source
12+
13+
Build the CLI tool:
14+
15+
```bash
16+
make build
17+
```
18+
19+
Or build manually:
20+
21+
```bash
22+
go build -o chartify ./cmd/chartify
23+
```
24+
25+
Build the chart repo server:
26+
27+
```bash
28+
make build/chartreposerver
29+
```
30+
31+
Or build manually:
32+
33+
```bash
34+
go build -o chartreposerver ./cmd/chartreposerver
35+
```
36+
37+
### Prerequisites
38+
39+
- Go 1.25.4+
40+
- Helm v4.1.0 (helm command)
41+
- Kustomize v5.8.0+ (kustomize command, optional, for kustomize integration)
42+
943
## CLI
1044

1145
Beyond it's usage with helmfile, it also provides a basic CLI application that can be run independently.
@@ -16,4 +50,15 @@ The simplest usage of the command is:
1650
$ chartify $RELEASE $CHART -o $OUTPUT_DIR
1751
```
1852

53+
Examples:
54+
55+
```bash
56+
# Build and run with a Helm chart
57+
make build
58+
./chartify -o /tmp/output test-release testdata/charts/log
59+
60+
# Build and run with Kubernetes manifests
61+
./chartify -o /tmp/output test-release testdata/kube_manifest_yml
62+
```
63+
1964
See `chartify -h` or `go run ./cmd/chartify -h` for more information.

0 commit comments

Comments
 (0)