Start go build and release tooling #8935

radTuti · 2024-06-22T00:30:12Z

Description

This is the core base of the go release tooling that will replace useage of Makefile and hack/release for a more cohesive process. It tries to adhere to standard go project layout

The borrows from the town in Bob the Builder: Ready Steady Build

Related issues/PRs

N/A

Todos

Tests
Documentation
Release note

Release Note

I'm going to go with not required atm until it gets intergrated

TBD

Reminder for the reviewer

Make sure that this PR has the correct labels and milestone set.

Every PR needs one docs-* label.

docs-pr-required: This change requires a change to the documentation that has not been completed yet.
docs-completed: This change has all necessary documentation completed.
docs-not-required: This change has no user-facing impact and requires no docs.

Every PR needs one release-note-* label.

release-note-required: This PR has user-facing changes. Most PRs should have this label.
release-note-not-required: This PR has no user-facing changes.

Other optional labels:

cherry-pick-candidate: This PR should be cherry-picked to an earlier release. For bug fixes only.
needs-operator-pr: This PR is related to install and requires a corresponding change to the operator.

- split DockerGoBuild to allow better reusability - reorganize file structure to adhere to gostandards - update reusable goyek section + rename

+ minor cleanups

caseydavenport · 2024-06-24T15:13:32Z

fixham/go.mod

@@ -0,0 +1,44 @@
+module github.com/projectcalico/fixham


I think we probably want to use the same go.mod / go.sum as the root of the project here? Is there a reason you have in mind not to?

fixham is a separate module that can be use on its own similar to api

I believe since we're narrowing in on release logic, we don't need to treat fixham as a library to be imported, rather it's a CLI tool that will orchestrate the release. So with that in mind, I think it will be better to use the existing go.mod / go.sum from the repository root.

fixham/pkg/bootstrap/bootstrap.go

fixham/pkg/bootstrap/test.go

fixham/pkg/bootstrap/bootstrap.go

fixham/build/main.go

fixham/internal/client/client.go

TODO: fix test

fixham/internal/docker/gobuild.go

caseydavenport · 2024-06-25T15:40:32Z

fixham/internal/docker/docker.go

+		return types.ContainerExecInspect{}, err
+	}
+
+	logrus.WithField("cmd", cmd).Print("printing output...\n", string(output), "\n...end of output")


Probably want to use logrus.WithField().Infof

caseydavenport · 2024-06-25T18:00:45Z

fixham/pkg/api/builder.go

+	tasks       map[string]*goyek.DefinedTask
+}
+
+// NewBuilder returns a new Component


I don't see a type Component anywhere - this comment is probably wrong.

caseydavenport · 2024-06-26T21:32:30Z

metadata.mk

@@ -22,6 +22,8 @@ UBI_VERSION=8.10
 # Configuration for Semaphore integration.
 ORGANIZATION = projectcalico

+export REPO_ROOT := $(shell git rev-parse --show-toplevel)


We shouldn't need this. The fixham Makefile should just import both lib.Makefile and metadata.mk and then export the variables that it needs itself.

Same for the GO_BUILD_VER above.

caseydavenport · 2024-06-26T21:34:40Z

api/build/update-client-gen.sh

@@ -1,44 +0,0 @@
-#!/bin/bash


Is removing this related to fixham at all? Is this just unused code?

caseydavenport · 2024-06-26T21:35:37Z

Makefile

@@ -1,3 +1,4 @@
+NAME = projectcalico


What is "NAME"?

This seems more like "ORGANIZATION", which is already defined in metadata.mk

caseydavenport · 2024-06-26T21:41:56Z

fixham/Makefile

+.PHONY: default
+default: fixham
+
+.PHONY: bin/fixham


bin/fixham isn't a PHONY target. PHONY should only be used on targets that don't actually produce a file, whereas bin/fixham does produce the file bin/fixham.

caseydavenport · 2024-06-26T21:42:14Z

fixham/Makefile

+fixham: bin/fixham
+	@bin/fixham $(ARGS)
+
+.PHONY: %


This seems unnecessary to me

caseydavenport · 2024-06-26T21:43:34Z

fixham/Makefile

@@ -0,0 +1,22 @@
+include ../metadata.mk
+
+export NAME = fixham


These shouldn't be exported. If you want to use them in a target, you should pass them as environment variables to the commands in that target.

caseydavenport · 2024-06-26T21:45:31Z

fixham/internal/config/config.go

+	Organization string `envconfig:"ORGANIZATION"`
+	// GoBuildImageName is the name of the go-build image
+	// if wanting to override calico/go-build
+	GoBuildImageName string `envconfig:"GO_BUILD_IMAGE" default:"calico/go-build"`


This is a nit, but these should have newlines before any commends for readability. e.g.,

Name string `envconfig:"NAME"` PackageName string `envconfig:"PACKAGE_NAME" required:"true"` Organization string `envconfig:"ORGANIZATION"` // GoBuildImageName is the name of the go-build image // if wanting to override calico/go-build GoBuildImageName string `envconfig:"GO_BUILD_IMAGE" default:"calico/go-build"` // GoBuildVersion is the version of the go-build image GoBuildVersion string `envconfig:"GO_BUILD_VER" required:"true"`

caseydavenport · 2024-06-26T22:09:40Z

fixham/go.mod

@@ -0,0 +1,44 @@
+module github.com/projectcalico/fixham


I believe since we're narrowing in on release logic, we don't need to treat fixham as a library to be imported, rather it's a CLI tool that will orchestrate the release. So with that in mind, I think it will be better to use the existing go.mod / go.sum from the repository root.

radTuti added 7 commits June 19, 2024 14:31

first stab at release lib

657b85c

first stab at using goyek

3a04f6f

clean ups

6695550

- split DockerGoBuild to allow better reusability - reorganize file structure to adhere to gostandards - update reusable goyek section + rename

add bootstrap task for clean

8150427

add test task and tests

0018eb7

rename lib & tool to fixham

af49ecb

+ minor cleanups

fix runner for calico/go-build to accomodate its usage

7a97308

radTuti added docs-not-required Docs not required for this change release-note-not-required Change has no user-facing impact labels Jun 22, 2024

radTuti requested a review from a team as a code owner June 22, 2024 00:30

marvin-tigera added this to the Calico v3.29.0 milestone Jun 22, 2024

nit

8ca2bc6

radTuti force-pushed the go-release-pkg branch from 3d25b42 to 8ca2bc6 Compare June 22, 2024 00:36

caseydavenport requested changes Jun 24, 2024

View reviewed changes

radTuti added 5 commits June 24, 2024 12:00

address comments in docker package

76e38a3

remove pilchard

73930bc

remove file package

594fd2c

remove client pkg

61d8369

update docker package

33237c1

radTuti force-pushed the go-release-pkg branch 4 times, most recently from 40970c2 to ea3550f Compare June 25, 2024 05:08

radTuti added 2 commits June 24, 2024 22:25

update structure

70ccdfd

TODO: fix test

add build dir for projectcalico

192170f

radTuti force-pushed the go-release-pkg branch from ea3550f to 9a03c6f Compare June 25, 2024 05:25

sample usage of calicocomponent build

4e8fe7a

radTuti force-pushed the go-release-pkg branch from 9a03c6f to 4e8fe7a Compare June 25, 2024 05:27

radTuti requested a review from caseydavenport June 25, 2024 05:30

radTuti force-pushed the go-release-pkg branch from 03fbef4 to 34ea0a7 Compare June 25, 2024 05:50

hjiawei reviewed Jun 25, 2024

View reviewed changes

fixham/internal/docker/gobuild.go Outdated Show resolved Hide resolved

radTuti force-pushed the go-release-pkg branch 3 times, most recently from 26a358c to cb7b9aa Compare June 25, 2024 11:33

additional cleanup

e6882dc

radTuti force-pushed the go-release-pkg branch from cb7b9aa to e6882dc Compare June 25, 2024 12:37

read GO_BUILD_VER from metadata.mk

4699443

radTuti requested a review from hjiawei June 25, 2024 18:07

update based on discussion for new design

379f008

radTuti force-pushed the go-release-pkg branch from 9caef58 to 379f008 Compare June 26, 2024 19:56

caseydavenport reviewed Jun 26, 2024

View reviewed changes

fix accidental deleteion

6a9249d

radTuti force-pushed the go-release-pkg branch from 1288f61 to 6a9249d Compare June 26, 2024 22:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Start go build and release tooling #8935

Start go build and release tooling #8935

radTuti commented Jun 22, 2024

caseydavenport Jun 24, 2024

radTuti Jun 25, 2024

caseydavenport Jun 26, 2024

caseydavenport Jun 25, 2024

caseydavenport Jun 25, 2024

caseydavenport Jun 26, 2024

caseydavenport Jun 26, 2024

caseydavenport Jun 26, 2024

caseydavenport Jun 26, 2024

caseydavenport Jun 26, 2024

caseydavenport Jun 26, 2024

caseydavenport Jun 26, 2024

caseydavenport Jun 26, 2024

Start go build and release tooling #8935

Are you sure you want to change the base?

Start go build and release tooling #8935

Conversation

radTuti commented Jun 22, 2024

Description

Related issues/PRs

Todos

Release Note

Reminder for the reviewer

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment