add prebuildDefaultBranchOnly to Project.settings

gitpod-io · Sep 14, 2023 · e5c8e3a · e5c8e3a
1 parent aa51d6c
commit e5c8e3a
Show file tree

Hide file tree

Showing 7 changed files with 115 additions and 88 deletions.
diff --git a/components/gitpod-protocol/go/gitpod-service.go b/components/gitpod-protocol/go/gitpod-service.go
@@ -2252,6 +2252,7 @@ type Project struct {
 
 type ProjectSettings struct {
 	EnablePrebuilds              bool                      `json:"enablePrebuilds,omitempty"`
+	PrebuildDefaultBranchOnly    bool                      `json:"prebuildDefaultBranchOnly,omitempty"`
 	UseIncrementalPrebuilds      bool                      `json:"useIncrementalPrebuilds,omitempty"`
 	UsePersistentVolumeClaim     bool                      `json:"usePersistentVolumeClaim,omitempty"`
 	KeepOutdatedPrebuildsRunning bool                      `json:"keepOutdatedPrebuildsRunning,omitempty"`

diff --git a/components/gitpod-protocol/src/teams-projects-protocol.ts b/components/gitpod-protocol/src/teams-projects-protocol.ts
@@ -15,6 +15,11 @@ export interface ProjectConfig {
 
 export interface ProjectSettings {
     enablePrebuilds?: boolean;
+    /**
+     * Wether prebuilds (if enabled) should only be started on the default branch.
+     * Defaults to `true` on project creation.
+     */
+    prebuildDefaultBranchOnly?: boolean;
     useIncrementalPrebuilds?: boolean;
     keepOutdatedPrebuildsRunning?: boolean;
     // whether new workspaces can start on older prebuilds and incrementally update

diff --git a/components/public-api-server/pkg/apiv1/project.go b/components/public-api-server/pkg/apiv1/project.go
@@ -170,6 +170,7 @@ func projectSettingsToAPIResponse(s *protocol.ProjectSettings) *v1.ProjectSettin
 	return &v1.ProjectSettings{
 		Prebuild: &v1.PrebuildSettings{
 			EnablePrebuilds:              s.EnablePrebuilds,
+			PrebuildDefaultBranchOnly:    s.PrebuildDefaultBranchOnly,
 			EnableIncrementalPrebuilds:   s.UseIncrementalPrebuilds,
 			KeepOutdatedPrebuildsRunning: s.KeepOutdatedPrebuildsRunning,
 			UsePreviousPrebuilds:         s.AllowUsingPreviousPrebuilds,

diff --git a/components/public-api/gitpod/experimental/v1/projects.proto b/components/public-api/gitpod/experimental/v1/projects.proto
@@ -48,6 +48,7 @@ message PrebuildSettings {
     bool use_previous_prebuilds = 3;
     int32 prebuild_every_nth = 4;
     bool enable_prebuilds = 5;
+    bool prebuild_default_branch_only = 6;
 }
 
 message WorkspaceSettings {

diff --git a/components/public-api/go/experimental/v1/projects.pb.go b/components/public-api/go/experimental/v1/projects.pb.go
diff --git a/components/public-api/typescript/src/gitpod/experimental/v1/projects_pb.ts b/components/public-api/typescript/src/gitpod/experimental/v1/projects_pb.ts
diff --git a/components/server/src/projects/projects-service.ts b/components/server/src/projects/projects-service.ts
@@ -30,6 +30,7 @@ import { ScmService } from "./scm-service";
 export class ProjectsService {
     public static PROJECT_SETTINGS_DEFAULTS: ProjectSettings = {
         enablePrebuilds: false,
+        prebuildDefaultBranchOnly: true,
     };
 
     constructor(