chore: ensure AUTHORS are generated automatically MONGOSH-647 (#745)

Author: rose-m

.github/workflows/cron-tasks.yml

@@ -0,0 +1,36 @@
+on:
+  # Once a week or on pushes to master
+  schedule:
+    - cron: "0 3 * * 0"
+  push:
+    branches:
+      - master
+
+jobs:
+  update_third_party_notices_and_authors:
+    name: Update THIRD_PARTY_NOTICES and AUTHORS
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v2
+      - name: Install Dependencies
+        run: npm run bootstrap-ci
+      - name: Set up Git
+        run: |
+          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+      - name: Update THIRD_PARTY_NOTICES.md
+        run: npm run update-third-party-notices
+      - name: Commit THIRD_PARTY_NOTICES changes
+        run: |
+          git commit --no-allow-empty -m "chore: update THIRD_PARTY_NOTICES" THIRD_PARTY_NOTICES.md || true
+      - name: Update AUTHORS
+        run: npm run update-authors
+      - name: Commit AUTHORS changes
+        run: |
+          git add AUTHORS \*/AUTHORS
+          git commit --no-allow-empty -m "chore: update AUTHORS" || true
+      - name: Push updates
+        uses: ad-m/[email protected]
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/update-third-party-notices.yml

@@ -8,3 +8,7 @@ Massimiliano Marcon <[email protected]>Massimiliano Marcon <[email protected]>
 Maurizio Casimirri <[email protected]> mcasimir <[email protected]>
 Rhys Howell <rhys@[email protected]> Rhys <[email protected]>
 Rhys Howell <rhys@[email protected]> Rhys Howell <[email protected]>
+Rhys Howell <rhys@[email protected]> Anemy <rhys@[email protected]>
+Michael Rose <[email protected]> rosem <[email protected]>
+Sergey Petushkov <[email protected]> Sergey Petushkov <[email protected]>
+Sergey Petushkov <[email protected]> Sergey <[email protected]>

.mailmap

@@ -53,6 +53,7 @@
     "report-supported-api": "lerna run --stream --scope @mongosh/shell-api report-supported-api",
     "report-coverage": "nyc report --reporter=text --reporter=html && nyc check-coverage --lines=95",
     "generate-error-overview": "lerna run --stream --scope @mongosh/errors generate-error-overview",
+    "update-authors": "ts-node -P config/tsconfig.base.json scripts/generate-authors.ts",
     "update-third-party-notices": "ts-node -P config/tsconfig.base.json scripts/gather-licenses.ts packages/cli-repl/ > THIRD_PARTY_NOTICES.md"
   },
   "config": {

package.json

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env ts-node
 
 /*
  * Generate an AUTHOR file on the repo root and on each lerna package based on git log.
@@ -7,22 +7,20 @@
  * names / emails.
  */
 
-const { execSync } = require('child_process');
-const path = require('path');
-const fs = require('fs');
+import { execSync } from 'child_process';
+import path from 'path';
+import fs from 'fs';
 
 const packageRootPath = path.resolve(__dirname, '..');
 
-
-
-function getAuthorsGitLog(packagePath) {
+function getAuthorsGitLog(packagePath: string): string[] {
   return execSync(
     `git log --reverse --format='%aN <%aE>' --use-mailmap -- ${packagePath}`,
     { cwd: packageRootPath }
   ).toString().trim().split('\n');
 }
 
-function getAuthorsOrderedByFirstCommit(packagePath) {
+function getAuthorsOrderedByFirstCommit(packagePath: string): string[] {
   const alreadyAdded = new Set();
   const authors = [];
 
@@ -35,13 +33,20 @@ function getAuthorsOrderedByFirstCommit(packagePath) {
   return authors;
 }
 
-function getAllPackages() {
-  return JSON.parse(execSync(`lerna list -a --loglevel=error --json`,
-  { cwd: packageRootPath }
-  ).toString().trim());
+interface Package {
+  location: string;
+}
+
+function getAllPackages(): Package[] {
+  return JSON.parse(
+    execSync(
+      `lerna list -a --loglevel=error --json`,
+      { cwd: packageRootPath }
+    ).toString().trim()
+  );
 }
 
-function renderAuthorsFileContent(authors) {
+function renderAuthorsFileContent(authors: string[]): string {
   return `${authors.join('\n')}\n`;
 }