Added notification on error (#9)

Added the ability to comment in a PR when it fails to update it.

It will link to the logs and inform the user on what they can do.

This resolves #8

.github/workflows/up-to-date.yml

@@ -7,6 +7,7 @@ on:
 
 jobs:
   updatePullRequests:
+    name: Keep PRs up to date
     runs-on: ubuntu-latest
     steps:
       - name: Update all the PRs

README.md

@@ -24,6 +24,7 @@ on:
 
 jobs:
   updatePullRequests:
+    name: Keep PRs up to date
     runs-on: ubuntu-latest
     steps:
       - name: Update all the PRs

action.yml

@@ -18,4 +18,4 @@ outputs:
 
 runs:
   using: 'docker'
-  image: 'docker://ghcr.io/paritytech/up-to-date-action/action:0.1.0'
+  image: 'docker://ghcr.io/paritytech/up-to-date-action/action:0.2.0'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "up-to-date-action",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Keep all your PRs up to date when a new commit is pushed to the main branch",
   "main": "src/index.ts",
   "scripts": {

src/github/pullRequest.ts

@@ -45,4 +45,12 @@ export class PullRequestApi {
 
     return data.message;
   }
+
+  async comment(number: number, msg: string): Promise<void> {
+    await this.api.rest.issues.createComment({
+      ...this.repo,
+      issue_number: number,
+      body: msg,
+    });
+  }
 }

src/index.ts

@@ -25,6 +25,7 @@ const logger = generateCoreLogger();
 const action = async () => {
   const token = getInput("GITHUB_TOKEN", { required: true });
   const repoInfo = getRepo(context);
+  const actionUrl = `${context.serverUrl}/${repoInfo.owner}/${repoInfo.repo}/actions/runs/${context.runId}`;
   const requireAutoMerge: boolean =
     getInput("REQUIRE_AUTO_MERGE", { required: false }) !== "false";
   const api = new PullRequestApi(getOctokit(token), repoInfo, logger);
@@ -54,6 +55,13 @@ const action = async () => {
       } catch (error) {
         logger.error(error as string | Error);
         rows.push([repoTxt, title, "Fail ❌"]);
+        await api.comment(
+          number,
+          "# Failed to update PR ❌\n\n" +
+            "There was an error while trying to keep this PR `up-to-date`\n\n" +
+            "You may have conflicts ‼️ or may have to manually sync it with the target branch 👉❇️\n\n" +
+            `More info in the [logs 📋](${actionUrl})`,
+        );
       }
     }
     logger.info("🪄 - Finished updating PRs");