|
| 1 | +import {spawnSync} from 'node:child_process'; |
| 2 | +import fs from 'node:fs/promises'; |
| 3 | +import path from 'node:path'; |
| 4 | + |
| 5 | +const version = process.argv[2]; |
| 6 | +const websiteRoot = process.cwd(); |
| 7 | +const versionsPath = path.join(websiteRoot, 'versions.json'); |
| 8 | + |
| 9 | +if (!version) { |
| 10 | + console.error('Usage: npm run refresh:docs-version -- <version>'); |
| 11 | + process.exit(1); |
| 12 | +} |
| 13 | + |
| 14 | +function isStableLineVersion(candidate) { |
| 15 | + return /^\d+\.\d+\.0$/.test(candidate); |
| 16 | +} |
| 17 | + |
| 18 | +function run(command, args) { |
| 19 | + const result = spawnSync(command, args, { |
| 20 | + cwd: websiteRoot, |
| 21 | + stdio: 'inherit', |
| 22 | + }); |
| 23 | + |
| 24 | + if (result.status !== 0) { |
| 25 | + throw new Error(`${[command, ...args].join(' ')} failed with status ${result.status ?? 1}`); |
| 26 | + } |
| 27 | +} |
| 28 | + |
| 29 | +async function pathExists(target) { |
| 30 | + try { |
| 31 | + await fs.access(target); |
| 32 | + return true; |
| 33 | + } catch (error) { |
| 34 | + if (error?.code === 'ENOENT') { |
| 35 | + return false; |
| 36 | + } |
| 37 | + throw error; |
| 38 | + } |
| 39 | +} |
| 40 | + |
| 41 | +async function moveIfExists(from, to) { |
| 42 | + if (await pathExists(from)) { |
| 43 | + await fs.mkdir(path.dirname(to), {recursive: true}); |
| 44 | + await fs.rename(from, to); |
| 45 | + return true; |
| 46 | + } |
| 47 | + return false; |
| 48 | +} |
| 49 | + |
| 50 | +async function restoreIfMoved(from, to, moved) { |
| 51 | + if (!moved) { |
| 52 | + return; |
| 53 | + } |
| 54 | + await fs.rm(to, {recursive: true, force: true}); |
| 55 | + await fs.mkdir(path.dirname(to), {recursive: true}); |
| 56 | + await fs.rename(from, to); |
| 57 | +} |
| 58 | + |
| 59 | +if (!isStableLineVersion(version)) { |
| 60 | + console.error( |
| 61 | + `Release-line docs refresh only supports stable release-line versions (X.Y.0). Patch releases update the existing release-line snapshot: ${version}`, |
| 62 | + ); |
| 63 | + process.exit(1); |
| 64 | +} |
| 65 | + |
| 66 | +const raw = await fs.readFile(versionsPath, 'utf8'); |
| 67 | +const originalVersions = JSON.parse(raw); |
| 68 | + |
| 69 | +if (!Array.isArray(originalVersions)) { |
| 70 | + throw new Error('versions.json is not an array'); |
| 71 | +} |
| 72 | + |
| 73 | +const dedupedOriginalVersions = [...new Set(originalVersions)]; |
| 74 | +if (!dedupedOriginalVersions.includes(version)) { |
| 75 | + console.error( |
| 76 | + `Docs version ${version} is not present in versions.json. Create the release-line snapshot first with: make docs-version DOCS_VERSION=${version}`, |
| 77 | + ); |
| 78 | + process.exit(1); |
| 79 | +} |
| 80 | + |
| 81 | +const tempRoot = path.join(websiteRoot, `.tmp-refresh-version-${process.pid}`); |
| 82 | +const versionedDocsDir = path.join(websiteRoot, 'versioned_docs', `version-${version}`); |
| 83 | +const versionedSidebarPath = path.join( |
| 84 | + websiteRoot, |
| 85 | + 'versioned_sidebars', |
| 86 | + `version-${version}-sidebars.json`, |
| 87 | +); |
| 88 | +const backupDocsDir = path.join(tempRoot, 'versioned_docs', `version-${version}`); |
| 89 | +const backupSidebarPath = path.join( |
| 90 | + tempRoot, |
| 91 | + 'versioned_sidebars', |
| 92 | + `version-${version}-sidebars.json`, |
| 93 | +); |
| 94 | + |
| 95 | +let movedDocs = false; |
| 96 | +let movedSidebar = false; |
| 97 | + |
| 98 | +try { |
| 99 | + await fs.rm(tempRoot, {recursive: true, force: true}); |
| 100 | + movedDocs = await moveIfExists(versionedDocsDir, backupDocsDir); |
| 101 | + movedSidebar = await moveIfExists(versionedSidebarPath, backupSidebarPath); |
| 102 | + await fs.writeFile( |
| 103 | + versionsPath, |
| 104 | + `${JSON.stringify(dedupedOriginalVersions.filter((candidate) => candidate !== version), null, 2)}\n`, |
| 105 | + ); |
| 106 | + |
| 107 | + run(process.platform === 'win32' ? 'npm.cmd' : 'npm', ['run', 'prepare:contribute']); |
| 108 | + run(process.platform === 'win32' ? 'npx.cmd' : 'npx', ['docusaurus', 'docs:version', version]); |
| 109 | + |
| 110 | + await fs.writeFile(versionsPath, `${JSON.stringify(dedupedOriginalVersions, null, 2)}\n`); |
| 111 | + await fs.rm(tempRoot, {recursive: true, force: true}); |
| 112 | +} catch (error) { |
| 113 | + await fs.rm(versionedDocsDir, {recursive: true, force: true}); |
| 114 | + await fs.rm(versionedSidebarPath, {force: true}); |
| 115 | + await restoreIfMoved(backupDocsDir, versionedDocsDir, movedDocs); |
| 116 | + await restoreIfMoved(backupSidebarPath, versionedSidebarPath, movedSidebar); |
| 117 | + await fs.writeFile(versionsPath, `${JSON.stringify(dedupedOriginalVersions, null, 2)}\n`); |
| 118 | + await fs.rm(tempRoot, {recursive: true, force: true}); |
| 119 | + console.error(error.message); |
| 120 | + process.exit(1); |
| 121 | +} |
0 commit comments