chore: Set up automatic updating of README (eslint#16717)

* chore: Set up automatic updating of README * Update tools/update-readme.js Co-authored-by: Milos Djermanovic <[email protected]> Co-authored-by: Milos Djermanovic <[email protected]>
cdreeves · Dec 28, 2022 · 8f17247 · 8f17247
1 parent 4e4049c
commit 8f17247
Show file tree

Hide file tree

Showing 5 changed files with 127 additions and 34 deletions.
diff --git a/.github/workflows/update-readme.yml b/.github/workflows/update-readme.yml
@@ -0,0 +1,33 @@
+name: Data Fetch
+
+on:
+  schedule:
+  - cron: "0 8 * * *" # Every day at 1am PDT
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out repo
+      uses: actions/checkout@v3
+      with:
+        token: ${{ secrets.WORKFLOW_PUSH_BOT_TOKEN }}
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v3
+
+    - name: Install npm packages
+      run: npm install
+
+    - name: Update README with latest team and sponsor data
+      run: npm run build:readme
+
+    - name: Setup Git
+      run: |
+        git config user.name "GitHub Actions Bot"
+        git config user.email "<[email protected]>"
+    
+    - name: Save updated files
+      run: |
+        chmod +x ./tools/commit-readme.sh
+        ./tools/commit-readme.sh
diff --git a/README.md b/README.md
@@ -245,11 +245,6 @@ Nitin Kumar
 The people who review and fix bugs and help triage issues.
 
 <table><tbody><tr><td align="center" valign="top" width="11%">
-<a href="https://github.com/brettz9">
-<img src="https://github.com/brettz9.png?s=75" width="75" height="75"><br />
-Brett Zamir
-</a>
-</td><td align="center" valign="top" width="11%">
 <a href="https://github.com/bmish">
 <img src="https://github.com/bmish.png?s=75" width="75" height="75"><br />
 Bryan Mishkin
@@ -260,14 +255,25 @@ Bryan Mishkin
 Sara Soueidan
 </a>
 </td><td align="center" valign="top" width="11%">
-<a href="https://github.com/g-plane">
-<img src="https://github.com/g-plane.png?s=75" width="75" height="75"><br />
-Pig Fang
+<a href="https://github.com/yeonjuan">
+<img src="https://github.com/yeonjuan.png?s=75" width="75" height="75"><br />
+YeonJuan
+</a>
+</td></tr></tbody></table>
+
+### Website Team
+
+Team members who focus specifically on eslint.org
+
+<table><tbody><tr><td align="center" valign="top" width="11%">
+<a href="https://github.com/bmish">
+<img src="https://github.com/bmish.png?s=75" width="75" height="75"><br />
+Bryan Mishkin
 </a>
 </td><td align="center" valign="top" width="11%">
-<a href="https://github.com/anikethsaha">
-<img src="https://github.com/anikethsaha.png?s=75" width="75" height="75"><br />
-Anix
+<a href="https://github.com/SaraSoueidan">
+<img src="https://github.com/SaraSoueidan.png?s=75" width="75" height="75"><br />
+Sara Soueidan
 </a>
 </td><td align="center" valign="top" width="11%">
 <a href="https://github.com/yeonjuan">
@@ -285,10 +291,10 @@ The following companies, organizations, and individuals support ESLint's ongoing
 <!-- NOTE: This section is autogenerated. Do not manually edit.-->
 <!--sponsorsstart-->
 <h3>Platinum Sponsors</h3>
-<p><a href="https://automattic.com"><img src="https://images.opencollective.com/automattic/d0ef3e1/logo.png" alt="Automattic" height="undefined"></a></p><h3>Gold Sponsors</h3>
-<p><a href="https://www.salesforce.com"><img src="https://images.opencollective.com/salesforce/ca8f997/logo.png" alt="Salesforce" height="96"></a> <a href="https://www.airbnb.com/"><img src="https://images.opencollective.com/airbnb/d327d66/logo.png" alt="Airbnb" height="96"></a> <a href="https://americanexpress.io"><img src="https://avatars.githubusercontent.com/u/3853301?v=4" alt="American Express" height="96"></a></p><h3>Silver Sponsors</h3>
-<p><a href="https://liftoff.io/"><img src="https://images.opencollective.com/liftoff/5c4fa84/logo.png" alt="Liftoff" height="64"></a></p><h3>Bronze Sponsors</h3>
-<p><a href="https://launchdarkly.com"><img src="https://images.opencollective.com/launchdarkly/574bb9e/logo.png" alt="launchdarkly" height="32"></a> <a href="https://nx.dev"><img src="https://images.opencollective.com/nx/0efbe42/logo.png" alt="Nx (by Nrwl)" height="32"></a> <a href="https://www.crosswordsolver.org/anagram-solver/"><img src="https://images.opencollective.com/anagram-solver/2666271/logo.png" alt="Anagram Solver" height="32"></a> <a href="https://www.vpsserver.com"><img src="https://images.opencollective.com/vpsservercom/logo.png" alt="VPS" height="32"></a> <a href="https://icons8.com"><img src="https://images.opencollective.com/icons8/7fa1641/logo.png" alt="Icons8: free icons, photos, illustrations, and music" height="32"></a> <a href="https://discord.com"><img src="https://images.opencollective.com/discordapp/f9645d9/logo.png" alt="Discord" height="32"></a> <a href="https://themeisle.com"><img src="https://images.opencollective.com/themeisle/d5592fe/logo.png" alt="ThemeIsle" height="32"></a> <a href="https://www.ignitionapp.com"><img src="https://avatars.githubusercontent.com/u/5753491?v=4" alt="Ignition" height="32"></a> <a href="https://herocoders.com"><img src="https://avatars.githubusercontent.com/u/37549774?v=4" alt="HeroCoders" height="32"></a></p>
+<p><a href="#"><img src="https://images.opencollective.com/2021-frameworks-fund/logo.png" alt="Chrome Frameworks Fund" height="undefined"></a> <a href="https://automattic.com"><img src="https://images.opencollective.com/automattic/d0ef3e1/logo.png" alt="Automattic" height="undefined"></a></p><h3>Gold Sponsors</h3>
+<p><a href="https://ridicorp.com/career/"><img src="https://images.opencollective.com/ridi-corporation/175dcf3/logo.png" alt="RIDI" height="96"></a> <a href="https://engineering.salesforce.com"><img src="https://images.opencollective.com/salesforce/ca8f997/logo.png" alt="Salesforce" height="96"></a> <a href="https://www.airbnb.com/"><img src="https://images.opencollective.com/airbnb/d327d66/logo.png" alt="Airbnb" height="96"></a></p><h3>Silver Sponsors</h3>
+<p><a href="https://sentry.io"><img src="https://avatars.githubusercontent.com/u/1396951?v=4" alt="Sentry" height="64"></a> <a href="https://liftoff.io/"><img src="https://images.opencollective.com/liftoff/5c4fa84/logo.png" alt="Liftoff" height="64"></a></p><h3>Bronze Sponsors</h3>
+<p><a href="https://themeisle.com"><img src="https://images.opencollective.com/themeisle/d5592fe/logo.png" alt="ThemeIsle" height="32"></a> <a href="https://nx.dev"><img src="https://images.opencollective.com/nx/0efbe42/logo.png" alt="Nx (by Nrwl)" height="32"></a> <a href="https://www.crosswordsolver.org/anagram-solver/"><img src="https://images.opencollective.com/anagram-solver/2666271/logo.png" alt="Anagram Solver" height="32"></a> <a href="https://icons8.com"><img src="https://images.opencollective.com/icons8/7fa1641/logo.png" alt="Icons8: free icons, photos, illustrations, and music" height="32"></a> <a href="https://discord.com"><img src="https://images.opencollective.com/discordapp/f9645d9/logo.png" alt="Discord" height="32"></a> <a href="https://www.ignitionapp.com"><img src="https://avatars.githubusercontent.com/u/5753491?v=4" alt="Ignition" height="32"></a> <a href="https://herocoders.com"><img src="https://avatars.githubusercontent.com/u/37549774?v=4" alt="HeroCoders" height="32"></a> <a href="https://quickbookstoolhub.com"><img src="https://avatars.githubusercontent.com/u/95090305?u=e5bc398ef775c9ed19f955c675cdc1fb6abf01df&v=4" alt="QuickBooks Tool hub" height="32"></a></p>
 <!--sponsorsend-->
 
 ## Technology Sponsors

diff --git a/package.json b/package.json
@@ -16,6 +16,7 @@
     "build:docs:update-links": "node tools/fetch-docs-links.js",
     "build:site": "node Makefile.js gensite",
     "build:webpack": "node Makefile.js webpack",
+    "build:readme": "node tools/update-readme.js",
     "lint": "node Makefile.js lint",
     "lint:docs:js": "node Makefile.js lintDocsJS",
     "lint:fix": "node Makefile.js lint -- fix",

diff --git a/tools/commit-readme.sh b/tools/commit-readme.sh
@@ -0,0 +1,18 @@
+#!/bin/bash
+
+#------------------------------------------------------------------------------
+# Commits the data files if any have changed
+#------------------------------------------------------------------------------
+
+if [ -z "$(git status --porcelain)" ]; then 
+	echo "Data did not change."
+else
+	echo "Data changed!"
+
+	# commit the result
+	git add README.md
+	git commit -m "docs: Update README"
+
+	# push back to source control
+	git push origin HEAD  
+fi
diff --git a/tools/update-readme.js b/tools/update-readme.js
@@ -13,20 +13,19 @@
 // Requirements
 //-----------------------------------------------------------------------------
 
-const path = require("path");
 const fs = require("fs");
 const { stripIndents } = require("common-tags");
 const ejs = require("ejs");
+const got = require("got");
 
 //-----------------------------------------------------------------------------
 // Data
 //-----------------------------------------------------------------------------
 
-const README_FILE_PATH = path.resolve(__dirname, "../README.md");
-const WEBSITE_DATA_PATH = path.resolve(__dirname, "../../website/_data");
+const SPONSORS_URL = "https://raw.githubusercontent.com/eslint/eslint.org/main/src/_data/sponsors.json";
+const TEAM_URL = "https://raw.githubusercontent.com/eslint/eslint.org/main/src/_data/team.json";
+const README_FILE_PATH = "./README.md";
 
-const team = JSON.parse(fs.readFileSync(path.join(WEBSITE_DATA_PATH, "team.json")));
-const allSponsors = JSON.parse(fs.readFileSync(path.join(WEBSITE_DATA_PATH, "sponsors.json")));
 const readme = fs.readFileSync(README_FILE_PATH, "utf8");
 
 const heights = {
@@ -35,13 +34,31 @@ const heights = {
     bronze: 32
 };
 
-// remove backers from sponsors list - not shown on readme
-delete allSponsors.backers;
-
 //-----------------------------------------------------------------------------
 // Helpers
 //-----------------------------------------------------------------------------
 
+/**
+ * Fetches the latest sponsors data from the website.
+ * @returns {Object} The sponsors data object.
+ */
+async function fetchSponsorsData() {
+    const data = await got(SPONSORS_URL).json();
+
+    // remove backers from sponsors list - not shown on readme
+    delete data.backers;
+
+    return data;
+}
+
+/**
+ * Fetches the latest team data from the website.
+ * @returns {Object} The sponsors data object.
+ */
+async function fetchTeamData() {
+    return got(TEAM_URL).json();
+}
+
 /**
  * Formats an array of team members for inclusion in the readme.
  * @param {Array} members The array of members to format.
@@ -74,7 +91,7 @@ function formatSponsors(sponsors) {
         ${
             nonEmptySponsors.map(tier => `<h3>${tier[0].toUpperCase()}${tier.slice(1)} Sponsors</h3>
             <p>${
-                sponsors[tier].map(sponsor => `<a href="${sponsor.url}"><img src="${sponsor.image}" alt="${sponsor.name}" height="${heights[tier]}"></a>`).join(" ")
+                sponsors[tier].map(sponsor => `<a href="${sponsor.url || "#"}"><img src="${sponsor.image}" alt="${sponsor.name}" height="${heights[tier]}"></a>`).join(" ")
             }</p>`).join("")
         }
     <!--sponsorsend-->`;
@@ -111,20 +128,38 @@ const HTML_TEMPLATE = stripIndents`
 
     <%- formatTeamMembers(team.committers) %>
 
+    <% } %>
+
+    <% if (team.website.length > 0) { %>
+    ### Website Team
+
+    Team members who focus specifically on eslint.org
+
+    <%- formatTeamMembers(team.website) %>
+
     <% } %>
     <!--teamend-->
 `;
 
-// replace all of the section
-let newReadme = readme.replace(/<!--teamstart-->[\w\W]*?<!--teamend-->/u, ejs.render(HTML_TEMPLATE, {
-    team,
-    formatTeamMembers
-}));
+(async () => {
+
+    const [allSponsors, team] = await Promise.all([
+        fetchSponsorsData(),
+        fetchTeamData()
+    ]);
+
+    // replace all of the section
+    let newReadme = readme.replace(/<!--teamstart-->[\w\W]*?<!--teamend-->/u, ejs.render(HTML_TEMPLATE, {
+        team,
+        formatTeamMembers
+    }));
+
+    newReadme = newReadme.replace(/<!--sponsorsstart-->[\w\W]*?<!--sponsorsend-->/u, formatSponsors(allSponsors));
 
-newReadme = newReadme.replace(/<!--sponsorsstart-->[\w\W]*?<!--sponsorsend-->/u, formatSponsors(allSponsors));
+    // replace multiple consecutive blank lines with just one blank line
+    newReadme = newReadme.replace(/(?<=^|\n)\n{2,}/gu, "\n");
 
-// replace multiple consecutive blank lines with just one blank line
-newReadme = newReadme.replace(/(?<=^|\n)\n{2,}/gu, "\n");
+    // output to the file
+    fs.writeFileSync(README_FILE_PATH, newReadme, "utf8");
 
-// output to the file
-fs.writeFileSync(README_FILE_PATH, newReadme, "utf8");
+})();