feat: adds caching, drops 6 / 7 generation

Author: reggi

cli/bin/build.js

@@ -27,7 +27,7 @@ const checkContent = () => {
 build({
   releases: require('../releases.json'),
   loglevel: process.argv.includes('--debug') || process.env.CI ? 'verbose' : 'info',
-  prerelease: true,
+  prerelease: false,
   useCurrent: checkOnly,
   contentPath,
   navPath,

cli/lib/build.js

@@ -5,6 +5,7 @@ const semver = require('semver')
 const pacote = require('pacote')
 const extractRelease = require('./extract')
 const log = require('./log')
+const {CacheVersionSha} = require('./cache')
 
 const DOCS_PATH = 'cli'
 
@@ -113,10 +114,15 @@ const main = async ({loglevel, releases: rawReleases, useCurrent, navPath, conte
     }
   })
 
+  const cache = await CacheVersionSha.load()
+
   const updates = await Promise.all(
-    releases.map(r => extractRelease(r, {contentPath, baseNav: navData, prerelease})),
+    releases.map(r => extractRelease(r, {cache, contentPath, baseNav: navData, prerelease})),
   ).then(r => r.filter(Boolean))
 
+  updates.forEach(r => cache.set(r.id, r.sha))
+  await cache.save()
+
   await updateNav(updates, {nav: navDoc, path: navPath})
 }
 

cli/lib/cache.js

@@ -0,0 +1,37 @@
+const {join} = require('path')
+const fs = require('fs/promises')
+
+/** cache npm cli version shas to NOT pull down changes we already have */
+class CacheVersionSha {
+  constructor(cache) {
+    this.cache = cache
+  }
+
+  static path = join(__dirname, '../../content/cli/cache.json')
+
+  static async load() {
+    return new CacheVersionSha(JSON.parse(await fs.readFile(this.path, 'utf-8')))
+  }
+
+  async save() {
+    await fs.writeFile(CacheVersionSha.path, JSON.stringify(this.cache, null, 2))
+    return this
+  }
+
+  get(id) {
+    return this.cache[id]
+  }
+
+  set(id, sha) {
+    this.cache[id] = sha
+    return this
+  }
+
+  same(id, value) {
+    return this.cache[id] === value
+  }
+}
+
+module.exports = {
+  CacheVersionSha,
+}

cli/lib/extract.js

@@ -138,7 +138,13 @@ const writeChangelog = async ({release, nav, cwd, srcPath, contentPath}) => {
   })
 }
 
-const unpackRelease = async (release, {contentPath, baseNav, prerelease = false}) => {
+const unpackRelease = async (release, {cache, contentPath, baseNav, prerelease = false}) => {
+  const sha = await gh.getCurrentSha(release.branch)
+  if (cache.same(release.id, sha)) {
+    log.info(`Skipping ${release.id} due to cache`)
+    return
+  }
+
   if (release.prerelease && !prerelease) {
     log.info(`Skipping ${release.id} due to prerelease ${release.version}`)
     return
@@ -219,6 +225,7 @@ const unpackRelease = async (release, {contentPath, baseNav, prerelease = false}
   return {
     ...release,
     nav: nav.children,
+    sha,
   }
 }
 

cli/lib/gh.js

@@ -15,6 +15,18 @@ const owner = 'npm'
 const repo = 'cli'
 const opts = {owner, repo}
 
+const getCurrentSha = async branch => {
+  if (!octokit) {
+    const {Octokit} = await import('@octokit/rest')
+    octokit = new Octokit({auth: process.env.GITHUB_TOKEN})
+  }
+  const {data} = await octokit.repos.getBranch({
+    ...opts,
+    branch,
+  })
+  return data.commit.sha
+}
+
 const getFile = async ({sha, ref, path}) => {
   if (!octokit) {
     const {Octokit} = await import('@octokit/rest')
@@ -57,5 +69,6 @@ const pathExists = async (ref, path) => {
 module.exports = {
   getFile,
   pathExists,
+  getCurrentSha,
   nwo: `${owner}/${repo}`,
 }

cli/releases.json

@@ -1,12 +1,4 @@
 [
-  {
-    "id": "v6",
-    "branch": "release/v6"
-  },
-  {
-    "id": "v7",
-    "branch": "release/v7"
-  },
   {
     "id": "v8",
     "branch": "release/v8"

content/cli/cache.json

@@ -0,0 +1 @@
+{}