feat: add go releaser #309

dierbei · 2023-06-21T08:00:07Z

netlify · 2023-06-21T08:00:13Z

✅ Deploy Preview for kamaji-documentation ready!

Name	Link
🔨 Latest commit	`fbcf89b`
🔍 Latest deploy log	https://app.netlify.com/sites/kamaji-documentation/deploys/649f7b31e99c4f0007bd2a3c
😎 Deploy Preview	https://deploy-preview-309--kamaji-documentation.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

prometherion

Thanks for picking up this, @dierbei!

Kamaji is using Go's ldflag to embed some information about itself version:

kamaji/Makefile

Lines 148 to 169 in 4db8230

 # Get information about git current status 

 GIT_HEAD_COMMIT ?= $$(git rev-parse --short HEAD) 

 GIT_TAG_COMMIT ?= $$(git rev-parse --short v$(VERSION)) 

 GIT_MODIFIED_1 ?= $$(git diff $(GIT_HEAD_COMMIT) $(GIT_TAG_COMMIT) --quiet && echo "" || echo ".dev") 

 GIT_MODIFIED_2 ?= $$(git diff --quiet && echo "" || echo ".dirty") 

 GIT_MODIFIED ?= $$(echo "$(GIT_MODIFIED_1)$(GIT_MODIFIED_2)") 

 GIT_REPO ?= $$(git config --get remote.origin.url) 

 BUILD_DATE ?= $$(git log -1 --format="%at" | xargs -I{} date -d @{} +%Y-%m-%dT%H:%M:%S) 

 build: generate fmt vet ## Build manager binary. 

 go build -o bin/manager main.go 

 run: manifests generate fmt vet ## Run a controller from your host. 

 go run ./main.go 

 docker-build: ## Build docker image with the manager. 

 docker build -t ${IMG} . --build-arg GIT_HEAD_COMMIT=$(GIT_HEAD_COMMIT) \ 

 --build-arg GIT_TAG_COMMIT=$(GIT_TAG_COMMIT) \ 

 --build-arg GIT_MODIFIED=$(GIT_MODIFIED) \ 

 --build-arg GIT_REPO=$(GIT_REPO) \ 

 --build-arg GIT_LAST_TAG=$(VERSION) \ 

 --build-arg BUILD_DATE=$(BUILD_DATE)

Are you aware if we can pass custom values as we're doing with regular Go builds?

kamaji/Dockerfile

Line 30 in 4db8230

 -ldflags "-X github.com/clastix/kamaji/internal.GitRepo=$GIT_REPO -X github.com/clastix/kamaji/internal.GitTag=$GIT_LAST_TAG -X github.com/clastix/kamaji/internal.GitCommit=$GIT_HEAD_COMMIT -X github.com/clastix/kamaji/internal.GitDirty=$GIT_MODIFIED -X github.com/clastix/kamaji/internal.BuildTime=$BUILD_DATE" \ 

dierbei · 2023-06-21T23:22:19Z

Thanks for your suggestion, I will try it later.

dierbei · 2023-06-22T04:24:23Z

I encountered another problem. When I tried to use make build to build the program, I encountered that fmt and vet were not defined, which caused the program to fail to build.

I tried adding the following code in the Makefile, do I need to fix this problem?

fmt:
	go fmt ./...

vet:
	go vet ./...

build: generate fmt vet ## Build manager binary.
	go build -o bin/manager main.go

dierbei · 2023-06-22T06:39:54Z

Thanks for picking up this, @dierbei!

Kamaji is using Go's ldflag to embed some information about itself version:

kamaji/Makefile

Lines 148 to 169 in 4db8230

# Get information about git current status

GIT_HEAD_COMMIT ?= $$(git rev-parse --short HEAD)

GIT_TAG_COMMIT ?= $$(git rev-parse --short v$(VERSION))

GIT_MODIFIED_1 ?= $$(git diff $(GIT_HEAD_COMMIT) $(GIT_TAG_COMMIT) --quiet && echo "" || echo ".dev")

GIT_MODIFIED_2 ?= $$(git diff --quiet && echo "" || echo ".dirty")

GIT_MODIFIED ?= $$(echo "$(GIT_MODIFIED_1)$(GIT_MODIFIED_2)")

GIT_REPO ?= $$(git config --get remote.origin.url)

BUILD_DATE ?= $$(git log -1 --format="%at" | xargs -I{} date -d @{} +%Y-%m-%dT%H:%M:%S)

build: generate fmt vet ## Build manager binary.

go build -o bin/manager main.go

run: manifests generate fmt vet ## Run a controller from your host.

go run ./main.go

docker-build: ## Build docker image with the manager.

docker build -t ${IMG} . --build-arg GIT_HEAD_COMMIT=$(GIT_HEAD_COMMIT) \

--build-arg GIT_TAG_COMMIT=$(GIT_TAG_COMMIT) \

--build-arg GIT_MODIFIED=$(GIT_MODIFIED) \

--build-arg GIT_REPO=$(GIT_REPO) \

--build-arg GIT_LAST_TAG=$(VERSION) \

--build-arg BUILD_DATE=$(BUILD_DATE)

Are you aware if we can pass custom values as we're doing with regular Go builds?

kamaji/Dockerfile

Line 30 in 4db8230

-ldflags "-X github.com/clastix/kamaji/internal.GitRepo=$GIT_REPO -X github.com/clastix/kamaji/internal.GitTag=$GIT_LAST_TAG -X github.com/clastix/kamaji/internal.GitCommit=$GIT_HEAD_COMMIT -X github.com/clastix/kamaji/internal.GitDirty=$GIT_MODIFIED -X github.com/clastix/kamaji/internal.BuildTime=$BUILD_DATE" \

After testing, it is already possible to pass parameters in the build process through ldflags.

Can you review it for me?

api/v1alpha1/groupversion_info.go

.goreleaser.yaml

Fix clastix#292

maxgio92 · 2023-08-24T09:14:45Z

Makefile

@@ -171,6 +171,24 @@ docker-build: ## Build docker image with the manager.
 docker-push: ## Push docker image with the manager.
 docker push ${IMG}

+create-tag: # Add a tag to the current commit and push it to the remote repository.
+ @git tag -a v$(VERSION) -m "Welcome to kamoji version $(VERSION)"


Hey @dierbei thank you! There's a typo here in kamaji version

maxgio92 · 2023-08-24T09:19:41Z

.goreleaser.yaml

+ filters:
+ exclude:
+ - '^docs:'
+ - '^test:'


Hi @dierbei, about releasing also the manifests we can use the release.extra_files to include with a glob pattern manifest files expected to be released to install Kamaji from bare manifets.

Then, update the checksum with the same extra_files content. What do you think?

In any case @prometherion, we should have in place (also generated from the pipeline with GitHub actions), a manifest that contain CRDs and Kamaji plus default DataStore (or CRDs and deployments separated).

maxgio92 · 2023-10-14T08:54:58Z

Hi @dierbei, did you have the chance to look into the suggestions?
Thank you!

dierbei · 2023-10-14T08:57:55Z

Hi @dierbei, did you have the chance to look into the suggestions? Thank you!

Sorry, I've been busy with grad school exams lately.

May not have much time.

prometherion reviewed Jun 21, 2023

View reviewed changes

dierbei force-pushed the add-go-releaser branch 7 times, most recently from b44a12a to 7eb1a05 Compare June 22, 2023 06:36

prometherion reviewed Jun 30, 2023

View reviewed changes

api/v1alpha1/groupversion_info.go Outdated Show resolved Hide resolved

.goreleaser.yaml Outdated Show resolved Hide resolved

feat: add go releaser

fbcf89b

Fix clastix#292

dierbei force-pushed the add-go-releaser branch from 7eb1a05 to fbcf89b Compare July 1, 2023 01:02

maxgio92 reviewed Aug 24, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add go releaser #309

feat: add go releaser #309

dierbei commented Jun 21, 2023

netlify bot commented Jun 21, 2023 •

edited

prometherion left a comment

dierbei commented Jun 21, 2023

dierbei commented Jun 22, 2023

dierbei commented Jun 22, 2023

maxgio92 Aug 24, 2023

maxgio92 Aug 24, 2023

maxgio92 commented Oct 14, 2023

dierbei commented Oct 14, 2023

	# Get information about git current status
	GIT_HEAD_COMMIT ?= $$(git rev-parse --short HEAD)
	GIT_TAG_COMMIT ?= $$(git rev-parse --short v$(VERSION))
	GIT_MODIFIED_1 ?= $$(git diff $(GIT_HEAD_COMMIT) $(GIT_TAG_COMMIT) --quiet && echo "" \|\| echo ".dev")
	GIT_MODIFIED_2 ?= $$(git diff --quiet && echo "" \|\| echo ".dirty")
	GIT_MODIFIED ?= $$(echo "$(GIT_MODIFIED_1)$(GIT_MODIFIED_2)")
	GIT_REPO ?= $$(git config --get remote.origin.url)
	BUILD_DATE ?= $$(git log -1 --format="%at" \| xargs -I{} date -d @{} +%Y-%m-%dT%H:%M:%S)

	build: generate fmt vet ## Build manager binary.
	go build -o bin/manager main.go

	run: manifests generate fmt vet ## Run a controller from your host.
	go run ./main.go

	docker-build: ## Build docker image with the manager.
	docker build -t ${IMG} . --build-arg GIT_HEAD_COMMIT=$(GIT_HEAD_COMMIT) \
	--build-arg GIT_TAG_COMMIT=$(GIT_TAG_COMMIT) \
	--build-arg GIT_MODIFIED=$(GIT_MODIFIED) \
	--build-arg GIT_REPO=$(GIT_REPO) \
	--build-arg GIT_LAST_TAG=$(VERSION) \
	--build-arg BUILD_DATE=$(BUILD_DATE)

feat: add go releaser #309

Are you sure you want to change the base?

feat: add go releaser #309

Conversation

dierbei commented Jun 21, 2023

netlify bot commented Jun 21, 2023 • edited

✅ Deploy Preview for kamaji-documentation ready!

prometherion left a comment

Choose a reason for hiding this comment

dierbei commented Jun 21, 2023

dierbei commented Jun 22, 2023

dierbei commented Jun 22, 2023

maxgio92 Aug 24, 2023

Choose a reason for hiding this comment

maxgio92 Aug 24, 2023

Choose a reason for hiding this comment

maxgio92 commented Oct 14, 2023

dierbei commented Oct 14, 2023

netlify bot commented Jun 21, 2023 •

edited