@ffflorian/auto-merge 1.0.2 → 1.1.0

package/README.md

@@ -27,7 +27,6 @@ Options:
   -a, --approve        approve before merging
   -c, --config <path>  specify a configuration file (default: .automergerc.json)
   -d, --dry-run        don't send any data
-  -f, --merge-drafts   merge draft PRs (default: false)
   -s, --squash         squash when merging (default: false)
   -V, --version        output the version number
   -h, --help           display help for command
@@ -41,20 +40,18 @@ The structure of the configuration file is the following:
 
 ```ts
 {
-  /** The GitHub auth token */
+  /** The GitHub auth token (needs read and write access to code and pull requests) */
   authToken: string;
   /** Approve before merging */
   autoApprove?: boolean;
   /** Don't send any data */
   dryRun?: boolean;
-  /** Merge draft PRs */
-  mergeDrafts?: boolean;
   /** All projects to include */
   projects: {
     /** All projects hosted on GitHub in the format `user/repo` */
     gitHub: string[];
   };
-  /* Squash when merging */
+  /** Squash when merging */
   squash?: boolean;
 }
 ```

package/dist/AutoMerge.d.ts

@@ -1,47 +1,4 @@
-/** @see https://docs.github.com/en/rest/reference/pulls#get-a-pull-request */
-interface GitHubPullRequest {
-    draft: boolean;
-    head: {
-        /** The branch name */
-        ref: string;
-        /** The commit SHA-1 hash */
-        sha: string;
-    };
-    /** The pull request number */
-    number: number;
-    /** The pull request title */
-    title: string;
-}
-export interface ActionResult {
-    error?: string;
-    pullNumber: number;
-    status: 'bad' | 'good';
-}
-export interface AutoMergeConfig {
-    /** The GitHub auth token */
-    authToken: string;
-    /** Approve before merging */
-    autoApprove?: boolean;
-    /** Don't send any data */
-    dryRun?: boolean;
-    /** Merge draft PRs */
-    mergeDrafts?: boolean;
-    /** All projects to include */
-    projects: {
-        /** All projects hosted on GitHub in the format `user/repo` */
-        gitHub: string[];
-    };
-    /** Squash when merging */
-    squash?: boolean;
-}
-export interface Repository {
-    pullRequests: GitHubPullRequest[];
-    repositorySlug: string;
-}
-export interface RepositoryResult {
-    actionResults: ActionResult[];
-    repositorySlug: string;
-}
+import type { AutoMergeConfig, ActionResult, Repository, RepositoryResult } from './types/index.js';
 export declare class AutoMerge {
     private readonly apiClient;
     private readonly config;
@@ -51,6 +8,7 @@ export declare class AutoMerge {
     private checkRepositorySlug;
     approveByMatch(regex: RegExp, repositories?: Repository[]): Promise<RepositoryResult[]>;
     private getMatchingRepositories;
+    private isPullRequestMergeable;
     mergeByMatch(regex: RegExp, repositories?: Repository[]): Promise<RepositoryResult[]>;
     approveByPullNumber(repositorySlug: string, pullNumber: number): Promise<ActionResult>;
     mergePullRequest(repositorySlug: string, pullNumber: number, squash?: boolean): Promise<ActionResult>;
@@ -62,4 +20,3 @@ export declare class AutoMerge {
     private putMerge;
     private getPullRequestsBySlug;
 }
-export {};

package/dist/AutoMerge.js

@@ -17,6 +17,7 @@ export class AutoMerge {
         this.apiClient = axios.create({
             baseURL: 'https://api.github.com',
             headers: {
+                Accept: 'application/vnd.github+json',
                 Authorization: `token ${this.config.authToken}`,
                 'User-Agent': `${toolName} v${toolVersion}`,
             },
@@ -45,33 +46,48 @@ export class AutoMerge {
     async approveByMatch(regex, repositories) {
         const allRepositories = repositories || (await this.getRepositoriesWithOpenPullRequests());
         const matchingRepositories = this.getMatchingRepositories(allRepositories, regex);
-        const resultPromises = matchingRepositories.map(async ({ pullRequests, repositorySlug }) => {
-            const actionPromises = pullRequests.map(pullRequest => this.approveByPullNumber(repositorySlug, pullRequest.number));
-            const actionResults = await Promise.all(actionPromises);
-            return { actionResults, repositorySlug };
-        });
-        return Promise.all(resultPromises);
+        const processedRepositories = [];
+        for (const { pullRequests, repositorySlug } of matchingRepositories) {
+            const actionResults = [];
+            for (const pullRequest of pullRequests) {
+                actionResults.push(await this.approveByPullNumber(repositorySlug, pullRequest.number));
+            }
+            processedRepositories.push({ actionResults, repositorySlug });
+        }
+        return processedRepositories;
     }
     getMatchingRepositories(repositories, regex) {
-        return repositories
-            .map(repository => {
+        const matchingRepositories = [];
+        for (const repository of repositories) {
             const matchingPullRequests = repository.pullRequests.filter(pullRequest => new RegExp(regex).test(pullRequest.head.ref));
             if (matchingPullRequests.length) {
-                return { pullRequests: matchingPullRequests, repositorySlug: repository.repositorySlug };
+                matchingRepositories.push({ pullRequests: matchingPullRequests, repositorySlug: repository.repositorySlug });
             }
-            return undefined;
-        })
-            .filter(Boolean);
+        }
+        return matchingRepositories;
+    }
+    async isPullRequestMergeable(repositorySlug, pullNumber) {
+        const resourceUrl = `/repos/${repositorySlug}/pulls/${pullNumber}`;
+        const response = await this.apiClient.get(resourceUrl);
+        return response.data.mergeable_state === 'clean';
     }
     async mergeByMatch(regex, repositories) {
         const allRepositories = repositories || (await this.getRepositoriesWithOpenPullRequests());
         const matchingRepositories = this.getMatchingRepositories(allRepositories, regex);
-        const resultPromises = matchingRepositories.map(async ({ pullRequests, repositorySlug }) => {
-            const actionPromises = pullRequests.map(pullRequest => this.mergePullRequest(repositorySlug, pullRequest.number, this.config.squash));
-            const actionResults = await Promise.all(actionPromises);
-            return { actionResults, repositorySlug };
-        });
-        return Promise.all(resultPromises);
+        const processedRepositories = [];
+        for (const { pullRequests, repositorySlug } of matchingRepositories) {
+            const actionResults = [];
+            for (const pullRequest of pullRequests) {
+                const isMergeable = this.isPullRequestMergeable(repositorySlug, pullRequest.number);
+                if (!isMergeable) {
+                    this.logger.warn(`Pull request #${pullRequest.number} in "${repositorySlug}" is not mergeable. Skipping.`);
+                    continue;
+                }
+                actionResults.push(await this.mergePullRequest(repositorySlug, pullRequest.number, this.config.squash));
+            }
+            processedRepositories.push({ actionResults, repositorySlug });
+        }
+        return processedRepositories;
     }
     async approveByPullNumber(repositorySlug, pullNumber) {
         const actionResult = { pullNumber, status: 'good' };
@@ -103,17 +119,17 @@ export class AutoMerge {
     }
     async getAllRepositories() {
         const repositorySlugs = this.config.projects.gitHub.filter(repositorySlug => this.checkRepositorySlug(repositorySlug));
-        const repositoriesPromises = repositorySlugs.map(async (repositorySlug) => {
+        const repositories = [];
+        for (const repositorySlug of repositorySlugs) {
             try {
                 const pullRequests = await this.getPullRequestsBySlug(repositorySlug);
-                return { pullRequests, repositorySlug };
+                repositories.push({ pullRequests, repositorySlug });
             }
             catch (error) {
                 this.logger.error(`Could not get pull requests for "${repositorySlug}": ${error.message}`);
-                return undefined;
             }
-        });
-        return (await Promise.all(repositoriesPromises)).filter(Boolean);
+        }
+        return repositories;
     }
     async getRepositoriesWithOpenPullRequests() {
         const allRepositories = await this.getAllRepositories();
@@ -131,11 +147,8 @@ export class AutoMerge {
     }
     async getPullRequestsBySlug(repositorySlug) {
         const resourceUrl = `/repos/${repositorySlug}/pulls`;
-        const params = { state: 'open' };
+        const params = { per_page: 100, state: 'open' };
         const response = await this.apiClient.get(resourceUrl, { params });
-        if (this.config.mergeDrafts) {
-            response.data = response.data.filter(pr => !pr.draft);
-        }
         return response.data;
     }
 }

package/dist/AutoMerge.test.js

@@ -44,11 +44,15 @@ describe('AutoMerge', () => {
                 },
             });
             nock(autoMerge['apiClient'].defaults.baseURL)
-                .post(/^\/repos\/[^/]+\/[^/]+\/pulls\/\d+\/reviews\/?$/)
+                .post(/^\/repos\/.+?\/.+?\/pulls\/\d+\/reviews\/?$/)
                 .reply(HTTP_STATUS.OK, { data: 'not-used' })
                 .persist();
             nock(autoMerge['apiClient'].defaults.baseURL)
-                .put(/^\/repos\/[^/]+\/[^/]+\/pulls\/\d+\/merge\/?$/)
+                .get(/^\/repos\/.+?\/.+?\/pulls\/\d+\/?$/)
+                .reply(HTTP_STATUS.OK, { data: 'not-used' })
+                .persist();
+            nock(autoMerge['apiClient'].defaults.baseURL)
+                .put(/^\/repos\/.+?\/.+?\/pulls\/\d+\/merge\/?$/)
                 .reply(HTTP_STATUS.OK, { data: 'not-used' })
                 .persist();
         });

package/dist/cli.js

@@ -37,7 +37,6 @@ const configFileData = {
     ...configResult.config,
     ...(commanderOptions.approve && { autoApprove: commanderOptions.approve }),
     ...(commanderOptions.dryRun && { dryRun: commanderOptions.dryRun }),
-    ...(commanderOptions.mergeDrafts && { mergeDrafts: commanderOptions.mergeDrafts }),
 };
 async function runAction(autoMerge, repositories, pullRequestSlug) {
     const regex = new RegExp(pullRequestSlug, 'gi');
@@ -46,12 +45,18 @@ async function runAction(autoMerge, repositories, pullRequestSlug) {
         approveResults = await autoMerge.approveByMatch(regex, repositories);
     }
     const mergeResults = await autoMerge.mergeByMatch(regex, repositories);
-    const actedRepositories = [...approveResults, ...mergeResults].reduce((count, repository) => {
-        return count + repository.actionResults.length;
-    }, 0);
-    const prPluralized = pluralize('PR', actedRepositories);
+    const successCount = [...approveResults, ...mergeResults].filter(repository => {
+        return repository.actionResults.some(result => typeof result.error === 'undefined');
+    }).length;
+    const prPluralized = pluralize('PR', successCount);
     const doAction = configFileData.autoApprove ? 'Approved and merged' : 'Merged';
-    logger.info(`${doAction} ${actedRepositories} ${prPluralized} matching "${regex}".`);
+    const infoMessage = `${doAction} ${successCount} ${prPluralized} matching "${regex}".`;
+    if (successCount === 0) {
+        logger.warn(infoMessage);
+    }
+    else {
+        logger.info(infoMessage);
+    }
 }
 function askQuestion(question) {
     return new Promise(resolve => {

package/package.json

@@ -2,8 +2,8 @@
   "author": "Florian Imdahl <git@ffflorian.de>",
   "bin": "dist/cli.js",
   "dependencies": {
-    "axios": "1.12.2",
-    "commander": "14.0.1",
+    "axios": "1.13.2",
+    "commander": "14.0.2",
     "cosmiconfig": "9.0.0",
     "logdown": "3.3.1"
   },
@@ -11,9 +11,10 @@
   "devDependencies": {
     "http-status-codes": "2.3.0",
     "nock": "14.0.10",
-    "rimraf": "6.0.1",
-    "typescript": "5.9.2",
-    "vitest": "3.2.4"
+    "rimraf": "6.1.0",
+    "tsx": "4.20.6",
+    "typescript": "5.9.3",
+    "vitest": "4.0.6"
   },
   "engines": {
     "node": ">= 18.0"
@@ -34,9 +35,10 @@
     "build": "tsc -p tsconfig.json",
     "clean": "rimraf dist",
     "dist": "yarn clean && yarn build",
-    "start": "node --loader ts-node/esm src/cli.ts",
+    "start": "tsx src/cli.ts",
     "test": "vitest run"
   },
   "type": "module",
-  "version": "1.0.2"
+  "version": "1.1.0",
+  "gitHead": "710af5a32b89acf0765daa81ced41e5031f67116"
 }