Merge pull request #10533 from gitbutlerapp/setting-for-disabling-pr-autofill

Add setting for PR Autofill

Author: Caleb-T-Owens

apps/desktop/cypress/e2e/support/mock/settings.ts

@@ -30,5 +30,8 @@ export const MOCK_APP_SETTINGS: AppSettings = {
 		dangerouslyAllowAllPermissions: false,
 		autoCommitAfterCompletion: true,
 		useConfiguredModel: false
+	},
+	reviews: {
+		autoFillPrDescriptionFromCommit: true
 	}
 };

apps/desktop/src/components/ReviewCreation.svelte

@@ -16,6 +16,7 @@
 	import { AI_SERVICE } from '$lib/ai/service';
 	import { BASE_BRANCH_SERVICE } from '$lib/baseBranch/baseBranchService.svelte';
 	import { type Commit } from '$lib/branches/v3';
+	import { SETTINGS_SERVICE } from '$lib/config/appSettingsV2';
 	import { projectAiGenEnabled, projectRunCommitHooks } from '$lib/config/config';
 	import { DEFAULT_FORGE_FACTORY } from '$lib/forge/forgeFactory.svelte';
 	import { mapErrorToToast } from '$lib/forge/github/errorMap';
@@ -61,6 +62,8 @@
 	const aiService = inject(AI_SERVICE);
 	const remotesService = inject(REMOTES_SERVICE);
 	const uiState = inject(UI_STATE);
+	const settingsService = inject(SETTINGS_SERVICE);
+	const appSettings = settingsService.appSettings;
 
 	const user = userService.user;
 
@@ -111,7 +114,8 @@
 	const isSubmittingReview = $derived(stackPush.current.isLoading || isCreatingReview);
 
 	async function getDefaultTitle(commits: Commit[]): Promise<string> {
-		if (commits.length === 1) {
+		const autoFill = $appSettings?.reviews.autoFillPrDescriptionFromCommit ?? true;
+		if (autoFill && commits.length === 1) {
 			const commitMessage = commits[0]!.message;
 			const { title } = splitMessage(commitMessage);
 			return title;
@@ -126,7 +130,8 @@
 		if ($templateEnabled && $templatePath) {
 			return await stackService.template(projectId, forge.current.name, $templatePath);
 		}
-		if (commits.length === 1) {
+		const autoFill = $appSettings?.reviews.autoFillPrDescriptionFromCommit ?? true;
+		if (autoFill && commits.length === 1) {
 			return splitMessage(commits[0]!.message).description;
 		}
 		return '';

apps/desktop/src/components/profileSettings/IntegrationsSettings.svelte

@@ -1,16 +1,45 @@
 <script lang="ts">
 	import AuthorizationBanner from '$components/AuthorizationBanner.svelte';
 	import GithubIntegration from '$components/GithubIntegration.svelte';
+	import { SETTINGS_SERVICE } from '$lib/config/appSettingsV2';
 	import { USER_SERVICE } from '$lib/user/userService';
 	import { inject } from '@gitbutler/core/context';
-	import { Spacer } from '@gitbutler/ui';
+	import { SectionCard, Spacer, Toggle } from '@gitbutler/ui';
 
 	const userService = inject(USER_SERVICE);
 	const user = userService.user;
+
+	const settingsService = inject(SETTINGS_SERVICE);
+	const appSettings = settingsService.appSettings;
+
+	async function toggleAutoFillPrDescription() {
+		await settingsService.updateReviews({
+			autoFillPrDescriptionFromCommit: !$appSettings?.reviews.autoFillPrDescriptionFromCommit
+		});
+	}
 </script>
 
 {#if !$user}
 	<AuthorizationBanner />
 	<Spacer />
 {/if}
 <GithubIntegration disabled={!$user} />
+
+<Spacer />
+
+<SectionCard labelFor="autoFillPrDescription" orientation="row">
+	{#snippet title()}
+		Auto-fill PR descriptions from commit
+	{/snippet}
+	{#snippet caption()}
+		When creating a pull request for a branch with just one commit, automatically use that commit's
+		message as the PR title and description.
+	{/snippet}
+	{#snippet actions()}
+		<Toggle
+			id="autoFillPrDescription"
+			checked={$appSettings?.reviews.autoFillPrDescriptionFromCommit ?? true}
+			onclick={toggleAutoFillPrDescription}
+		/>
+	{/snippet}
+</SectionCard>

apps/desktop/src/lib/config/appSettingsV2.ts

@@ -59,6 +59,10 @@ export class SettingsService {
 		await this.backend.invoke('update_claude', { update });
 	}
 
+	async updateReviews(update: Partial<Reviews>) {
+		await this.backend.invoke('update_reviews', { update });
+	}
+
 	private async nudge(): Promise<void> {
 		await this.autoOptInWs3();
 		await this.autoOptInRules();
@@ -144,6 +148,8 @@ export type AppSettings = {
 	fetch: Fetch;
 	/** Settings related to Claude Code */
 	claude: Claude;
+	/** Settings related to code reviews and pull requests */
+	reviews: Reviews;
 };
 
 export type TelemetrySettings = {
@@ -191,3 +197,8 @@ export type Claude = {
 	/** Whether to use the configured model in .claude/settings.json instead of passing --model. */
 	useConfiguredModel: boolean;
 };
+
+export type Reviews = {
+	/** Whether to auto-fill PR title and description from the first commit when a branch has only one commit. */
+	autoFillPrDescriptionFromCommit: boolean;
+};

crates/but-api/src/commands/settings.rs

@@ -1,6 +1,6 @@
 //! In place of commands.rs
 use but_api_macros::api_cmd;
-use but_settings::api::{ClaudeUpdate, FeatureFlagsUpdate, TelemetryUpdate};
+use but_settings::api::{ClaudeUpdate, FeatureFlagsUpdate, ReviewsUpdate, TelemetryUpdate};
 use but_settings::{AppSettings, AppSettingsWithDiskSync};
 use serde::Deserialize;
 use tracing::instrument;
@@ -89,3 +89,18 @@ pub fn update_claude(
         .update_claude(params.update)
         .map_err(|e| e.into())
 }
+
+#[derive(Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct UpdateReviewsParams {
+    pub update: ReviewsUpdate,
+}
+
+pub fn update_reviews(
+    app_settings_sync: &AppSettingsWithDiskSync,
+    params: UpdateReviewsParams,
+) -> Result<(), Error> {
+    app_settings_sync
+        .update_reviews(params.update)
+        .map_err(|e| e.into())
+}

crates/but-settings/assets/defaults.jsonc

@@ -57,5 +57,10 @@
 		"autoCommitAfterCompletion": true,
 		// Whether to use the configured model in .claude/settings.json instead of passing --model.
 		"useConfiguredModel": false
+	},
+	// Settings related to code reviews and pull requests.
+	"reviews": {
+		// Whether to auto-fill PR title and description from the first commit when a branch has only one commit.
+		"autoFillPrDescriptionFromCommit": true
 	}
 }

crates/but-settings/src/api.rs

@@ -35,6 +35,13 @@ pub struct ClaudeUpdate {
     pub use_configured_model: Option<bool>,
 }
 
+#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
+#[serde(rename_all = "camelCase")]
+/// Update request for [`crate::app_settings::Reviews`].
+pub struct ReviewsUpdate {
+    pub auto_fill_pr_description_from_commit: Option<bool>,
+}
+
 /// Mutation, immediately followed by writing everything to disk.
 impl AppSettingsWithDiskSync {
     pub fn update_onboarding_complete(&self, update: bool) -> Result<()> {
@@ -118,4 +125,15 @@ impl AppSettingsWithDiskSync {
         }
         settings.save()
     }
+
+    pub fn update_reviews(&self, update: ReviewsUpdate) -> Result<()> {
+        let mut settings = self.get_mut_enforce_save()?;
+        if let Some(auto_fill_pr_description_from_commit) =
+            update.auto_fill_pr_description_from_commit
+        {
+            settings.reviews.auto_fill_pr_description_from_commit =
+                auto_fill_pr_description_from_commit;
+        }
+        settings.save()
+    }
 }

crates/but-settings/src/app_settings.rs

@@ -82,3 +82,10 @@ pub struct Claude {
     /// Whether to use the configured model in .claude/settings.json instead of passing --model.
     pub use_configured_model: bool,
 }
+
+#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
+#[serde(rename_all = "camelCase")]
+pub struct Reviews {
+    /// Whether to auto-fill PR title and description from the first commit when a branch has only one commit.
+    pub auto_fill_pr_description_from_commit: bool,
+}

crates/but-settings/src/lib.rs

@@ -20,6 +20,8 @@ pub struct AppSettings {
     pub fetch: app_settings::Fetch,
     /// Settings related to Claude Code.
     pub claude: app_settings::Claude,
+    /// Settings related to code reviews and pull requests.
+    pub reviews: app_settings::Reviews,
 }
 
 impl Default for AppSettings {