Adds and updates footer in stacked pull request descriptions

apps/desktop/src/lib/branch/BranchLaneContextMenu.svelte

@@ -2,13 +2,17 @@
 	import ContextMenu from '$lib/components/contextmenu/ContextMenu.svelte';
 	import ContextMenuItem from '$lib/components/contextmenu/ContextMenuItem.svelte';
 	import ContextMenuSection from '$lib/components/contextmenu/ContextMenuSection.svelte';
+	import { getForgePrService } from '$lib/forge/interface/forgePrService';
+	import { updatePrDescriptionTables } from '$lib/forge/shared/stackFooter';
+	import { User } from '$lib/stores/user';
 	import { BranchController } from '$lib/vbranches/branchController';
 	import { VirtualBranch } from '$lib/vbranches/types';
 	import { getContext, getContextStore } from '@gitbutler/shared/context';
 	import Button from '@gitbutler/ui/Button.svelte';
 	import Modal from '@gitbutler/ui/Modal.svelte';
 	import Toggle from '@gitbutler/ui/Toggle.svelte';
 	import Tooltip from '@gitbutler/ui/Tooltip.svelte';
+	import { isDefined } from '@gitbutler/ui/utils/typeguards';
 
 	interface Props {
 		prUrl?: string;
@@ -26,6 +30,8 @@
 
 	const branchStore = getContextStore(VirtualBranch);
 	const branchController = getContext(BranchController);
+	const prService = getForgePrService();
+	const user = getContextStore(User);
 
 	let deleteBranchModal: Modal;
 	let allowRebasing = $state<boolean>();
@@ -37,6 +43,8 @@
 		allowRebasing = branch.allowRebasing;
 	});
 
+	const allPrIds = $derived(branch.series.map((series) => series.forgeId).filter(isDefined));
+
 	async function toggleAllowRebasing() {
 		branchController.updateBranchAllowRebasing(branch.id, !allowRebasing);
 	}
@@ -113,6 +121,21 @@
 			}}
 		/>
 	</ContextMenuSection>
+	{#if $user && $user.role?.includes('admin')}
+		<ContextMenuSection label="admin only">
+			<ContextMenuItem
+				label="Update PR footers"
+				disabled={allPrIds.length === 0}
+				onclick={() => {
+					if ($prService && branch) {
+						const allPrIds = branch.series.map((series) => series.forgeId).filter(isDefined);
+						updatePrDescriptionTables($prService, allPrIds);
+					}
+					contextMenuEl?.close();
+				}}
+			/>
+		</ContextMenuSection>
+	{/if}
 </ContextMenu>
 
 <Modal

apps/desktop/src/lib/components/contextmenu/ContextMenuSection.svelte

@@ -1,8 +1,14 @@
 <script lang="ts">
+	import type { Snippet } from 'svelte';
+
+	const { label, children }: { label?: string; children: Snippet } = $props();
 </script>
 
 <div class="context-menu-section">
-	<slot />
+	{#if label}
+		<div class="label text-12">{label}</div>
+	{/if}
+	{@render children()}
 </div>
 
 <style lang="postcss">
@@ -17,4 +23,10 @@
 			border-top: 1px solid var(--clr-border-2);
 		}
 	}
+
+	.label {
+		padding: 6px 8px;
+		color: var(--clr-scale-ntrl-50);
+		user-select: none;
+	}
 </style>

apps/desktop/src/lib/forge/github/githubPrService.ts

@@ -108,6 +108,17 @@ export class GitHubPrService implements ForgePrService {
 		if (!isGitHubPr(id)) throw INVALID_PR_TYPE;
 		return new GitHubPrMonitor(this, id);
 	}
+
+	async update(id: PullRequestId, details: { description?: string }) {
+		if (!isGitHubPr(id)) throw INVALID_PR_TYPE;
+		const { description } = details;
+		await this.octokit.pulls.update({
+			owner: this.repo.owner,
+			repo: this.repo.name,
+			pull_number: id.subject.prNumber,
+			body: description
+		});
+	}
 }
 
 function isGitHubPr(

apps/desktop/src/lib/forge/interface/forgePrService.ts

@@ -26,4 +26,5 @@ export interface ForgePrService {
 	merge(method: MergeMethod, id: PullRequestId): Promise<void>;
 	reopen(id: PullRequestId): Promise<void>;
 	prMonitor(id: PullRequestId): ForgePrMonitor;
+	update(id: PullRequestId, details: { description?: string }): Promise<void>;
 }

apps/desktop/src/lib/forge/shared/stackFooter.ts

@@ -0,0 +1,49 @@
+import { equalPrId } from './pullRequestId';
+import type { DetailedPullRequest, PullRequestId } from '$lib/forge/interface/types';
+import type { ForgePrService } from '../interface/forgePrService';
+
+export const GITBUTLER_FOOTER_BOUNDARY = '<!-- GitButler Footer Boundary -->';
+
+export async function updatePrDescriptionTables(prService: ForgePrService, prIds: PullRequestId[]) {
+	if (prService && prIds.length > 1) {
+		const prs = await Promise.all(prIds.map(async (prId) => await prService.get(prId)));
+		await Promise.all(
+			prIds.map(async (prId) => {
+				const pr = prs.find((p) => equalPrId(p.id, prId)) as DetailedPullRequest;
+				const currentDescription = pr.body ? stripFooter(pr.body.trim()) : '';
+				await prService.update(pr.id, {
+					description: currentDescription + '\n' + generateFooter(prId, prs)
+				});
+			})
+		);
+	}
+}
+
+/**
+ * Generates a footer for use in pull request descriptions when part of a stack.
+ */
+export function generateFooter(id: PullRequestId, all: DetailedPullRequest[]) {
+	const stackIndex = all.findIndex((pr) => equalPrId(pr.id, id));
+	let footer = '';
+	footer += GITBUTLER_FOOTER_BOUNDARY + '\n\n';
+	footer += `| # | PR |\n`;
+	footer += '| --- | --- |\n';
+	all.forEach((pr, i) => {
+		const current = i === stackIndex;
+		const rankNumber = all.length - i;
+		const rankStr = current ? bold(rankNumber) : rankNumber;
+		const prNumber = `#${pr.number}`;
+		const prStr = current ? bold(prNumber) : prNumber;
+		footer += `| ${rankStr} | ${prStr} |\n`;
+	});
+	return footer;
+}
+
+function stripFooter(description: string) {
+	console.log(description.split(GITBUTLER_FOOTER_BOUNDARY));
+	return description.split(GITBUTLER_FOOTER_BOUNDARY)[0];
+}
+
+function bold(text: string | number) {
+	return `**${text}**`;
+}

apps/desktop/src/lib/pr/PrDetailsModal.svelte

@@ -21,6 +21,12 @@
 	import { mapErrorToToast } from '$lib/forge/github/errorMap';
 	import { getForge } from '$lib/forge/interface/forge';
 	import { getForgePrService } from '$lib/forge/interface/forgePrService';
+	import {
+		ForgeName,
+		type DetailedPullRequest,
+		type PullRequest
+	} from '$lib/forge/interface/types';
+	import { updatePrDescriptionTables } from '$lib/forge/shared/stackFooter';
 	import { showError, showToast } from '$lib/notifications/toasts';
 	import { isFailure } from '$lib/result';
 	import ScrollableContainer from '$lib/scroll/ScrollableContainer.svelte';
@@ -39,8 +45,8 @@
 	import Textarea from '@gitbutler/ui/Textarea.svelte';
 	import Textbox from '@gitbutler/ui/Textbox.svelte';
 	import ToggleButton from '@gitbutler/ui/ToggleButton.svelte';
+	import { isDefined } from '@gitbutler/ui/utils/typeguards';
 	import { tick } from 'svelte';
-	import type { DetailedPullRequest, PullRequest } from '$lib/forge/interface/types';
 
 	interface BaseProps {
 		type: 'display' | 'preview' | 'preview-series';
@@ -165,6 +171,9 @@
 			error('Pull request service not available');
 			return;
 		}
+		if (props.type !== 'preview-series') {
+			return;
+		}
 
 		isLoading = true;
 		try {
@@ -210,11 +219,14 @@
 				baseBranchName,
 				upstreamName: upstreamBranchName
 			});
-			if (props.type === 'preview-series') {
-				await branchController.updateSeriesForgeId(props.stackId, props.currentSeries.name, {
-					type: 'GitHub',
-					subject: { prNumber: pr.number }
-				});
+			await branchController.updateSeriesForgeId(props.stackId, props.currentSeries.name, {
+				type: ForgeName.GitHub,
+				subject: { prNumber: pr.number }
+			});
+			const allPrIds = branch.series.map((series) => series.forgeId).filter(isDefined);
+			// Only add/update stack list if we have more than one.
+			if (allPrIds.length > 1) {
+				updatePrDescriptionTables($prService, allPrIds);
 			}
 		} catch (err: any) {
 			console.error(err);