feat: respect PR template if found

Author: jeremycolin

packages/frontend-updates-runner/src/create-pull-request.ts

@@ -10,6 +10,7 @@ export async function createPullRequest({
   packageName,
   packageVersion,
   updateBody,
+  template,
 }: {
   octokitWithAuth: Octokit;
   owner: string;
@@ -20,22 +21,31 @@ export async function createPullRequest({
   packageName: string;
   packageVersion: string;
   updateBody: string;
+  template: string | null;
 }) {
-  const { data } = await octokitWithAuth.rest.pulls.create({
+  const response = await octokitWithAuth.rest.pulls.create({
     owner,
     repo,
     title,
     head,
     base,
   });
 
+  const { data } = response;
+
   const previousBody = data.body ? `${data.body}\n\n` : "";
 
+  let body = `${previousBody}This PR was created by Simple Frontend (Jeremy) following an important release for ${packageName}.\n\n${updateBody}`;
+
+  if (template) {
+    body = `${body}\n\n${template}`;
+  }
+
   await octokitWithAuth.rest.pulls.update({
     owner,
     repo,
     pull_number: data.number,
-    body: `${previousBody}This PR was created by Simple Frontend (Jeremy) following an important release for ${packageName}.\n\n${updateBody}`,
+    body,
   });
 
   console.log(`Pull request created: ${owner}/${repo}#${data.number}`);

packages/frontend-updates-runner/src/get-repository-pull-request-template.ts

@@ -0,0 +1,32 @@
+import { Octokit } from "octokit";
+
+const PR_TEMPLATE_PATHS = [".github/pull_request_template.md", ".github/PULL_REQUEST_TEMPLATE.md"];
+
+export async function getRepositoryPullRequestTemplate({
+  octokitWithAuth,
+  owner,
+  repo,
+}: {
+  octokitWithAuth: Octokit;
+  owner: string;
+  repo: string;
+}): Promise<string | null> {
+  for (const path of PR_TEMPLATE_PATHS) {
+    try {
+      const res = await octokitWithAuth.rest.repos.getContent({
+        owner,
+        repo,
+        path,
+      });
+
+      // check that it's a file content
+      if ("content" in res.data) {
+        return Buffer.from(res.data.content, res.data.encoding as BufferEncoding).toString("utf-8");
+      }
+    } catch (error) {
+      console.warn(`Unable to read PR template at ${path} for ${owner}/${repo}`);
+    }
+  }
+
+  return null;
+}

packages/frontend-updates-runner/src/local-run.ts

@@ -0,0 +1,7 @@
+import "dotenv/config";
+import { rmSync } from "node:fs";
+import { resolve } from "node:path";
+
+rmSync(resolve(process.env.GITHUB_WORKSPACE!, "repositories"), { recursive: true, force: true });
+
+import "./update-depency-in-repos.js";

packages/frontend-updates-runner/src/update-depency-in-repos.ts

@@ -10,6 +10,7 @@ import { packageInRepo } from "./check-package-in-repo.js";
 import { execSync } from "child_process";
 import { createPullRequest } from "./create-pull-request.js";
 import { getUpdateBody } from "./get-update-body.js";
+import { getRepositoryPullRequestTemplate } from "./get-repository-pull-request-template.js";
 
 const REPOSITORIES_PATH = resolve(process.env.GITHUB_WORKSPACE!, "repositories");
 
@@ -36,6 +37,12 @@ export async function updateDependencyInRepos({
           installationId: installation.id,
         });
 
+        const template = await getRepositoryPullRequestTemplate({
+          octokitWithAuth,
+          owner: repository.owner.login,
+          repo: repository.name,
+        });
+
         const git = simpleGit()
           .addConfig("user.email", "jeremypa.colin@gmail.com", false, "global")
           .addConfig("user.name", "Jeremy Colin (Simple Frontend)", false, "global");
@@ -106,6 +113,7 @@ export async function updateDependencyInRepos({
           packageName,
           packageVersion,
           updateBody,
+          template,
         });
       } catch (error) {
         console.error(error);