Added pullRequestNumber to the action's outputs (#167)

dmregister · Andarist · web-flow · commit 993a0a090df7 · 2022-04-07T19:10:26.000+02:00
* feat: set pullRequesstNumber as action output

* chore: add changeset

* fix: feedback from pr review

* Update .changeset/long-mayflies-yell.md

Co-authored-by: Mateusz Burzyński &lt;mateuszburzynski@gmail.com&gt;

Co-authored-by: Mateusz Burzyński &lt;mateuszburzynski@gmail.com&gt;
diff --git a/.changeset/long-mayflies-yell.md b/.changeset/long-mayflies-yell.md
@@ -0,0 +1,5 @@
+---
+"@changesets/action": minor
+---
+
+Added `pullRequestNumber` to the action's outputs
diff --git a/action.yml b/action.yml
@@ -36,6 +36,8 @@ outputs:
       A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
   hasChangesets:
     description: A boolean about whether there were changesets. Useful if you want to create your own publishing functionality.
+  pullRequestNumber:
+    description: The pull request number that was created or updated
 branding:
   icon: "package"
   color: "blue"
diff --git a/src/index.ts b/src/index.ts
@@ -97,13 +97,16 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
       return;
     }
     case hasChangesets:
-      await runVersion({
+      const { pullRequestNumber } = await runVersion({
         script: getOptionalInput("version"),
         githubToken,
         prTitle: getOptionalInput("title"),
         commitMessage: getOptionalInput("commit"),
         hasPublishScript,
       });
+
+      core.setOutput("pullRequestNumber", String(pullRequestNumber));
+
       return;
   }
 })().catch((err) => {
diff --git a/src/run.test.ts b/src/run.test.ts
@@ -57,6 +57,10 @@ describe("version", () => {
       () => ({ data: { items: [] } })
     );
 
+    mockedGithubMethods.pulls.create.mockImplementationOnce(
+      () => ({ data: { number: 123 } })
+    );
+
     await writeChangesets(
       [
         {
@@ -92,6 +96,10 @@ describe("version", () => {
       () => ({ data: { items: [] } })
     );
 
+    mockedGithubMethods.pulls.create.mockImplementationOnce(
+      () => ({ data: { number: 123 } })
+    );
+
     await writeChangesets(
       [
         {
@@ -123,6 +131,10 @@ describe("version", () => {
       () => ({ data: { items: [] } })
     );
 
+    mockedGithubMethods.pulls.create.mockImplementationOnce(
+      () => ({ data: { number: 123 } })
+    );
+
     await writeChangesets(
       [
         {
diff --git a/src/run.ts b/src/run.ts
@@ -177,14 +177,18 @@ type VersionOptions = {
   hasPublishScript?: boolean;
 };
 
+type RunVersionResult = {
+  pullRequestNumber: number;
+};
+
 export async function runVersion({
   script,
   githubToken,
   cwd = process.cwd(),
   prTitle = "Version Packages",
   commitMessage = "Version Packages",
   hasPublishScript = false,
-}: VersionOptions) {
+}: VersionOptions): Promise<RunVersionResult> {
   let repo = `${github.context.repo.owner}/${github.context.repo.repo}`;
   let branch = github.context.ref.replace("refs/heads/", "");
   let versionBranch = `changeset-release/${branch}`;
@@ -280,20 +284,30 @@ ${
   console.log(JSON.stringify(searchResult.data, null, 2));
   if (searchResult.data.items.length === 0) {
     console.log("creating pull request");
-    await octokit.pulls.create({
+    const {
+      data: { number },
+    } = await octokit.pulls.create({
       base: branch,
       head: versionBranch,
       title: finalPrTitle,
       body: await prBodyPromise,
       ...github.context.repo,
     });
+
+    return {
+      pullRequestNumber: number,
+    };
   } else {
-    octokit.pulls.update({
+    await octokit.pulls.update({
       pull_number: searchResult.data.items[0].number,
       title: finalPrTitle,
       body: await prBodyPromise,
       ...github.context.repo,
     });
     console.log("pull request found");
+
+    return {
+      pullRequestNumber: searchResult.data.items[0].number,
+    };
   }
 }

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@changesets/action": minor
 +---
++
 +Added `pullRequestNumber` to the action's outputs
Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,10 @@ describe("version", () => {`
`57`	`57`	`() => ({ data: { items: [] } })`
`58`	`58`	`);`
`59`	`59`
	`60`	`+ mockedGithubMethods.pulls.create.mockImplementationOnce(`
	`61`	`+ () => ({ data: { number: 123 } })`
	`62`	`+ );`
	`63`	`+`
`60`	`64`	`await writeChangesets(`
`61`	`65`	`[`
`62`	`66`	`{`
`@@ -92,6 +96,10 @@ describe("version", () => {`
`92`	`96`	`() => ({ data: { items: [] } })`
`93`	`97`	`);`
`94`	`98`
	`99`	`+ mockedGithubMethods.pulls.create.mockImplementationOnce(`
	`100`	`+ () => ({ data: { number: 123 } })`
	`101`	`+ );`
	`102`	`+`
`95`	`103`	`await writeChangesets(`
`96`	`104`	`[`
`97`	`105`	`{`
`@@ -123,6 +131,10 @@ describe("version", () => {`
`123`	`131`	`() => ({ data: { items: [] } })`
`124`	`132`	`);`
`125`	`133`
	`134`	`+ mockedGithubMethods.pulls.create.mockImplementationOnce(`
	`135`	`+ () => ({ data: { number: 123 } })`
	`136`	`+ );`
	`137`	`+`
`126`	`138`	`await writeChangesets(`
`127`	`139`	`[`
`128`	`140`	`{`