evaluate prebuildDefaultBranchOnly in PrebuildManager

gitpod-io · Sep 14, 2023 · 632d1bd · 632d1bd
1 parent 2209661
commit 632d1bd
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 9 deletions.
diff --git a/components/server/src/prebuilds/bitbucket-app.ts b/components/server/src/prebuilds/bitbucket-app.ts
@@ -136,7 +136,7 @@ export class BitbucketApp {
                 commit: context.revision,
             });
             const config = await this.prebuildManager.fetchConfig({ span }, user, context);
-            if (!this.prebuildManager.shouldPrebuild({ config, project })) {
+            if (!this.prebuildManager.shouldPrebuild({ config, project, context })) {
                 log.info("Bitbucket push event: No prebuild.", { config, context });
                 await this.webhookEvents.updateEvent(event.id, {
                     prebuildStatus: "ignored_unconfigured",

diff --git a/components/server/src/prebuilds/bitbucket-server-app.ts b/components/server/src/prebuilds/bitbucket-server-app.ts
@@ -137,7 +137,7 @@ export class BitbucketServerApp {
                 commit: context.revision,
             });
             const config = await this.prebuildManager.fetchConfig({ span }, user, context);
-            if (!this.prebuildManager.shouldPrebuild({ config, project })) {
+            if (!this.prebuildManager.shouldPrebuild({ config, project, context })) {
                 log.info("Bitbucket Server push event: No prebuild.", { config, context });
                 await this.webhookEvents.updateEvent(event.id, {
                     prebuildStatus: "ignored_unconfigured",

diff --git a/components/server/src/prebuilds/github-app.ts b/components/server/src/prebuilds/github-app.ts
@@ -310,7 +310,7 @@ export class GithubApp {
             });
 
             const runPrebuild =
-                this.prebuildManager.shouldPrebuild({ config, project }) &&
+                this.prebuildManager.shouldPrebuild({ config, project, context }) &&
                 this.appRules.shouldRunPrebuild(config, branch == repo.default_branch, false, false);
             if (!runPrebuild) {
                 const reason = `Not running prebuild, the user did not enable it for this context or did not configure prebuild task(s)`;
@@ -538,7 +538,7 @@ export class GithubApp {
 
         const isFork = pr.head.repo.id !== pr.base.repo.id;
         const runPrebuild =
-            this.prebuildManager.shouldPrebuild({ config, project }) &&
+            this.prebuildManager.shouldPrebuild({ config, project, context }) &&
             this.appRules.shouldRunPrebuild(config, false, true, isFork);
         if (runPrebuild) {
             const commitInfo = await this.getCommitInfo(user, ctx.payload.repository.html_url, pr.head.sha);

diff --git a/components/server/src/prebuilds/github-enterprise-app.ts b/components/server/src/prebuilds/github-enterprise-app.ts
@@ -169,7 +169,7 @@ export class GitHubEnterpriseApp {
 
             const config = await this.prebuildManager.fetchConfig({ span }, user, context);
             if (
-                !this.prebuildManager.shouldPrebuild({ config, project }) ||
+                !this.prebuildManager.shouldPrebuild({ config, project, context }) ||
                 !this.appRules.shouldRunPrebuild(config, context.ref === context.repository.defaultBranch, false, false)
             ) {
                 log.info("GitHub Enterprise push event: No prebuild.", { config, context });

diff --git a/components/server/src/prebuilds/gitlab-app.ts b/components/server/src/prebuilds/gitlab-app.ts
@@ -161,7 +161,7 @@ export class GitLabApp {
             });
 
             const config = await this.prebuildManager.fetchConfig({ span }, user, context);
-            if (!this.prebuildManager.shouldPrebuild({ config, project })) {
+            if (!this.prebuildManager.shouldPrebuild({ config, project, context })) {
                 log.info("GitLab push event: No prebuild.", { config, context });
                 await this.webhookEvents.updateEvent(event.id, {
                     prebuildStatus: "ignored_unconfigured",

diff --git a/components/server/src/prebuilds/prebuild-manager.ts b/components/server/src/prebuilds/prebuild-manager.ts
@@ -341,8 +341,8 @@ export class PrebuildManager {
         }
     }
 
-    shouldPrebuild(params: { config: WorkspaceConfig; project: Project }): boolean {
-        const { config, project } = params;
+    shouldPrebuild(params: { config: WorkspaceConfig; project: Project; context: CommitContext }): boolean {
+        const { config, project, context } = params;
         if (!config || !config._origin || config._origin !== "repo") {
             // we demand an explicit gitpod config
             return false;
@@ -353,7 +353,21 @@ export class PrebuildManager {
             return false;
         }
 
-        return Project.isPrebuildsEnabled(project);
+        const isPrebuildsEnabled = Project.isPrebuildsEnabled(project);
+        if (!isPrebuildsEnabled) {
+            return false;
+        }
+
+        if (!project.settings?.prebuildDefaultBranchOnly) {
+            return true;
+        }
+
+        const defaultBranch = context.repository.defaultBranch;
+        if (!defaultBranch) {
+            log.debug("CommitContext is missing the default branch.", { context });
+            return true;
+        }
+        return context.ref === defaultBranch;
     }
 
     protected shouldPrebuildIncrementally(cloneUrl: string, project: Project): boolean {