Skip to content

Commit 82804d5

Browse files
committed
fix(server): honor GitLab default template casing and Azure template search order
1 parent 85a2679 commit 82804d5

2 files changed

Lines changed: 101 additions & 20 deletions

File tree

‎apps/server/src/sourceControl/PrTemplateDetection.test.ts‎

Lines changed: 65 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,22 @@ const TEMPLATE_DIRECTORIES = [
2828
"docs/PULL_REQUEST_TEMPLATE",
2929
] as const;
3030

31-
const GITLAB_TEMPLATE_PATHS = [
32-
".gitlab/merge_request_templates/Default.md",
33-
".gitlab/merge_request_templates/default.md",
31+
const GITLAB_DEFAULT_TEMPLATE_NAMES = [
32+
"Default.md",
33+
"default.md",
34+
"DEFAULT.MD",
35+
"Default.MD",
36+
] as const;
37+
38+
const AZURE_DEVOPS_TEMPLATE_PATHS = [
39+
".azuredevops/pull_request_template.md",
40+
".azuredevops/pull_request_template.txt",
41+
".vsts/pull_request_template.md",
42+
".vsts/pull_request_template.txt",
43+
"docs/pull_request_template.md",
44+
"docs/pull_request_template.txt",
45+
"pull_request_template.md",
46+
"pull_request_template.txt",
3447
] as const;
3548

3649
const PrTemplateDetectionTestLayer = GitVcsDriver.layer.pipe(
@@ -150,29 +163,71 @@ it.effect.each(TEMPLATE_DIRECTORIES)("recognizes the $0 directory", (relativeDir
150163
),
151164
);
152165

153-
it.effect.each(GITLAB_TEMPLATE_PATHS)(
154-
"recognizes the GitLab merge request template at $0",
166+
it.effect.each(GITLAB_DEFAULT_TEMPLATE_NAMES)(
167+
"recognizes the GitLab default template named $0",
168+
(templateFileName) =>
169+
runWithTempDirectory((cwd) =>
170+
Effect.gen(function* () {
171+
const relativePath = `.gitlab/merge_request_templates/${templateFileName}`;
172+
yield* writeTemplate(cwd, relativePath, `template from ${templateFileName}`);
173+
yield* commitTemplates(cwd);
174+
175+
const template = yield* detectTemplate(cwd, "HEAD", "gitlab");
176+
assert.strictEqual(Option.getOrUndefined(template), `template from ${templateFileName}`);
177+
}),
178+
),
179+
);
180+
181+
it.effect("prefers the GitLab default template over named templates", () =>
182+
runWithTempDirectory((cwd) =>
183+
Effect.gen(function* () {
184+
yield* writeTemplate(cwd, ".gitlab/merge_request_templates/Default.md", "default template");
185+
yield* writeTemplate(cwd, ".gitlab/merge_request_templates/feature.md", "feature template");
186+
yield* commitTemplates(cwd);
187+
188+
const template = yield* detectTemplate(cwd, "HEAD", "gitlab");
189+
assert.strictEqual(Option.getOrUndefined(template), "default template");
190+
}),
191+
),
192+
);
193+
194+
it.effect("does not use a named GitLab template when no default exists", () =>
195+
runWithTempDirectory((cwd) =>
196+
Effect.gen(function* () {
197+
yield* writeTemplate(cwd, ".gitlab/merge_request_templates/feature.md", "feature template");
198+
yield* commitTemplates(cwd);
199+
200+
const template = yield* detectTemplate(cwd, "HEAD", "gitlab");
201+
assert.isTrue(Option.isNone(template));
202+
}),
203+
),
204+
);
205+
206+
it.effect.each(AZURE_DEVOPS_TEMPLATE_PATHS)(
207+
"recognizes the Azure DevOps template at $0",
155208
(relativePath) =>
156209
runWithTempDirectory((cwd) =>
157210
Effect.gen(function* () {
158211
yield* writeTemplate(cwd, relativePath, `template from ${relativePath}`);
159212
yield* commitTemplates(cwd);
160213

161-
const template = yield* detectTemplate(cwd, "HEAD", "gitlab");
214+
const template = yield* detectTemplate(cwd, "HEAD", "azure-devops");
162215
assert.strictEqual(Option.getOrUndefined(template), `template from ${relativePath}`);
163216
}),
164217
),
165218
);
166219

167-
it.effect("recognizes the Azure DevOps pull request template", () =>
220+
it.effect("uses the first Azure DevOps template in folder precedence order", () =>
168221
runWithTempDirectory((cwd) =>
169222
Effect.gen(function* () {
170-
const relativePath = ".azuredevops/pull_request_template.md";
171-
yield* writeTemplate(cwd, relativePath, `template from ${relativePath}`);
223+
yield* writeTemplate(cwd, ".azuredevops/pull_request_template.txt", "azuredevops txt");
224+
yield* writeTemplate(cwd, ".vsts/pull_request_template.md", "vsts md");
225+
yield* writeTemplate(cwd, "docs/pull_request_template.txt", "docs txt");
226+
yield* writeTemplate(cwd, "pull_request_template.md", "root md");
172227
yield* commitTemplates(cwd);
173228

174229
const template = yield* detectTemplate(cwd, "HEAD", "azure-devops");
175-
assert.strictEqual(Option.getOrUndefined(template), `template from ${relativePath}`);
230+
assert.strictEqual(Option.getOrUndefined(template), "azuredevops txt");
176231
}),
177232
),
178233
);

‎apps/server/src/sourceControl/PrTemplateDetection.ts‎

Lines changed: 36 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,29 +23,44 @@ const GITHUB_TEMPLATE_DIRECTORIES = [
2323
"docs/PULL_REQUEST_TEMPLATE",
2424
] as const;
2525

26-
// GitLab treats the default merge request template as "Default.md" (case-insensitive).
26+
// GitLab's default merge request template is "Default.md" (case-insensitive) inside
27+
// .gitlab/merge_request_templates/. Other templates in that directory are chosen
28+
// explicitly by name instead of being applied by default.
2729
// https://docs.gitlab.com/user/project/description_templates/
28-
const GITLAB_TEMPLATE_PATHS = [
29-
".gitlab/merge_request_templates/Default.md",
30-
".gitlab/merge_request_templates/default.md",
31-
] as const;
30+
const GITLAB_TEMPLATE_DIRECTORIES = [".gitlab/merge_request_templates"] as const;
3231

33-
// Azure Repos applies pull_request_template.md from the repository's .azuredevops folder
34-
// before any other documented location.
32+
// Azure Repos searches these folders in order (.azuredevops, .vsts, docs, root) for
33+
// pull_request_template.md or pull_request_template.txt and uses the first default
34+
// template it finds. Filenames and folder locations are not case sensitive.
3535
// https://learn.microsoft.com/en-us/azure/devops/repos/git/pull-request-templates
36-
const AZURE_DEVOPS_TEMPLATE_PATHS = [".azuredevops/pull_request_template.md"] as const;
36+
const AZURE_DEVOPS_TEMPLATE_PATHS = [
37+
".azuredevops/pull_request_template.md",
38+
".azuredevops/pull_request_template.txt",
39+
".vsts/pull_request_template.md",
40+
".vsts/pull_request_template.txt",
41+
"docs/pull_request_template.md",
42+
"docs/pull_request_template.txt",
43+
"pull_request_template.md",
44+
"pull_request_template.txt",
45+
] as const;
3746

3847
interface ChangeRequestTemplatePaths {
3948
readonly paths: ReadonlyArray<string>;
4049
readonly directories: ReadonlyArray<string>;
50+
// When set, directory templates must match this basename (case-insensitive).
51+
readonly directoryBaseName?: string;
4152
}
4253

4354
function templatePathsForProvider(
4455
providerKind: SourceControlProviderKind,
4556
): ChangeRequestTemplatePaths | null {
4657
switch (providerKind) {
4758
case "gitlab":
48-
return { paths: [...GITLAB_TEMPLATE_PATHS], directories: [] };
59+
return {
60+
paths: [],
61+
directories: [...GITLAB_TEMPLATE_DIRECTORIES],
62+
directoryBaseName: "Default",
63+
};
4964
case "azure-devops":
5065
return { paths: [...AZURE_DEVOPS_TEMPLATE_PATHS], directories: [] };
5166
case "github":
@@ -130,6 +145,7 @@ function readTemplateDirectory(input: {
130145
readonly executeGit: ExecuteGit;
131146
readonly entries: ReadonlyArray<TemplateTreeEntry>;
132147
readonly directory: string;
148+
readonly expectedBaseName?: string | undefined;
133149
}): Effect.Effect<DirectoryTemplateResult, GitCommandError> {
134150
return Effect.gen(function* () {
135151
const prefix = `${input.directory}/`;
@@ -138,7 +154,16 @@ function readTemplateDirectory(input: {
138154
return false;
139155
}
140156
const relativePath = entry.path.slice(prefix.length);
141-
return !relativePath.includes("/") && relativePath.toLowerCase().endsWith(".md");
157+
if (relativePath.includes("/") || !relativePath.toLowerCase().endsWith(".md")) {
158+
return false;
159+
}
160+
if (input.expectedBaseName) {
161+
const baseName = relativePath.slice(0, relativePath.lastIndexOf("."));
162+
if (baseName.toLowerCase() !== input.expectedBaseName.toLowerCase()) {
163+
return false;
164+
}
165+
}
166+
return true;
142167
});
143168

144169
const templates: string[] = [];
@@ -202,6 +227,7 @@ export const detectPrTemplate = Effect.fn("detectPrTemplate")(function* (
202227
executeGit,
203228
entries,
204229
directory,
230+
expectedBaseName: templatePaths.directoryBaseName,
205231
});
206232
if (directoryTemplate._tag === "Template") {
207233
return Option.some(directoryTemplate.template);

0 commit comments

Comments
 (0)