fix: owners.txt names display first. filter robot such as github-actions

Author: WynterDing

lib/git-contributor.js

@@ -59,8 +59,22 @@ const getInfoFromGithubNewAPI = info => {
   return requestGithub(uri);
 };
 
+const isBotUser = (login) => {
+  const botPatterns = [
+    'github-actions',
+    'dependabot',
+    'renovate',
+    'greenkeeper',
+    'snyk-bot',
+    'codecov',
+    'coveralls'
+  ];
+  const lowerLogin = login.toLowerCase();
+  return botPatterns.some(pattern => lowerLogin.includes(pattern)) || lowerLogin.endsWith('[bot]');
+};
+
 const format = list => {
-  return list.filter(item => item).map(item => {
+  return list.filter(item => item && !isBotUser(item.login)).map(item => {
     return {
       login: item.login,
       avatar_url: item.avatar_url,
@@ -103,7 +117,9 @@ exports.getAuthor = async (options = {}) => {
   const ownersPath = options.owners ? path.resolve(cwd, options.owners) : null;
 
   let authorList = [];
+  let contributorList = [];
 
+  // First, get contributors from GitHub or git log
   if (_.isExistedFile(originPkg)) {
     try {
       const pkg = require(originPkg);
@@ -119,49 +135,53 @@ exports.getAuthor = async (options = {}) => {
         if (repoUrl) {
           const info = await getRepoInfo(repoUrl);
           const infoList = await getInfoFromGithubNewAPI(info);
-          authorList = format(infoList);
+          contributorList = format(infoList);
         }
       }
     } catch (e) {
     }
   } else if (pointGithubRepoUrl) {
     const info = await getRepoInfo(pointGithubRepoUrl);
     const infoList = await getInfoFromGithubNewAPI(info);
-    authorList = format(infoList);
+    contributorList = format(infoList);
   }
 
-  if (!authorList.length) {
+  if (!contributorList.length) {
     if (!_.isExistedDir(dotGitDir)) {
-      authorList = [];
+      contributorList = [];
     } else {
       const mailList = gitLog2MailList();
       const infoList = await getInfoFromGithub(_.uniq(mailList));
-      authorList = format(infoList);
+      contributorList = format(infoList);
     }
   }
 
+  // Process owners first (they get priority)
   if (ownersPath) {
     const owners = parseOwnersFile(ownersPath);
     if (owners.length) {
       owners.forEach(login => {
-        authorList.push({
-          login,
-          avatar_url: `https://avatars.githubusercontent.com/${login}?v=4`,
-          html_url: `https://github.com/${login}`
-        });
+        // Skip bot users
+        if (!isBotUser(login)) {
+          authorList.push({
+            login,
+            avatar_url: `https://avatars.githubusercontent.com/${login}?v=4`,
+            html_url: `https://github.com/${login}`
+          });
+        }
       });
     }
   }
 
-  // Deduplicate by login
-  const uniqueAuthors = new Map();
-  authorList.forEach(author => {
-    if (!uniqueAuthors.has(author.login)) {
-      uniqueAuthors.set(author.login, author);
+  // Then append contributors that are not already in the owners list
+  const ownersLoginSet = new Set(authorList.map(author => author.login));
+  contributorList.forEach(contributor => {
+    if (!ownersLoginSet.has(contributor.login)) {
+      authorList.push(contributor);
     }
   });
 
-  return Array.from(uniqueAuthors.values());
+  return authorList;
 };
 
 const ifHasZh = (readMeContext) => {

test/git-contributor.test.js

@@ -266,24 +266,85 @@ describe('git-contributor', () => {
       owners: 'owners.txt'
     });
 
-    // Should have 3 users (alpha, gamma from API, beta from owners)
+    // Should have 3 users with owners taking priority
     // alpha should appear only once (not duplicated)
+    // Order: owners first (alpha, beta), then contributors not in owners (gamma)
     assert.equal(list.length, 3);
     assert.deepEqual(list, [
       {
         login: 'alpha',
-        avatar_url: 'avatar-a-api', // Should keep the first occurrence (API version)
-        html_url: 'html-a'
+        avatar_url: 'https://avatars.githubusercontent.com/alpha?v=4', // Should keep owners version
+        html_url: 'https://github.com/alpha'
+      },
+      {
+        login: 'beta',
+        avatar_url: 'https://avatars.githubusercontent.com/beta?v=4',
+        html_url: 'https://github.com/beta'
       },
       {
         login: 'gamma',
         avatar_url: 'avatar-g',
         html_url: 'html-g'
+      }
+    ]);
+  });
+
+  it('filters out bot users', async () => {
+    const request = async (uri) => {
+      return {
+        data: [
+          {
+            login: 'realuser',
+            avatar_url: 'avatar-r',
+            html_url: 'html-r'
+          },
+          {
+            login: 'github-actions[bot]',
+            avatar_url: 'avatar-bot1',
+            html_url: 'html-bot1'
+          },
+          {
+            login: 'dependabot[bot]',
+            avatar_url: 'avatar-bot2',
+            html_url: 'html-bot2'
+          },
+          {
+            login: 'renovate[bot]',
+            avatar_url: 'avatar-bot3',
+            html_url: 'html-bot3'
+          },
+          {
+            login: 'anotheruser',
+            avatar_url: 'avatar-a',
+            html_url: 'html-a'
+          }
+        ]
+      };
+    };
+
+    const contributor = loadContributor({
+      request,
+      isExistedFile: () => false,
+      isExistedDir: () => false
+    });
+
+    const list = await contributor.getAuthor({
+      cwd: makeTempDir(),
+      url: 'https://github.com/foo/bar'
+    });
+
+    // Should only have real users, bot users filtered out
+    assert.equal(list.length, 2);
+    assert.deepEqual(list, [
+      {
+        login: 'realuser',
+        avatar_url: 'avatar-r',
+        html_url: 'html-r'
       },
       {
-        login: 'beta',
-        avatar_url: 'https://avatars.githubusercontent.com/beta?v=4',
-        html_url: 'https://github.com/beta'
+        login: 'anotheruser',
+        avatar_url: 'avatar-a',
+        html_url: 'html-a'
       }
     ]);
   });