chore: rename publishList

payloadcms · May 9, 2024 · 1467bc6 · 1467bc6
1 parent b651580
commit 1467bc6
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 13 deletions.
diff --git a/scripts/lib/getPackageRegistryVersions.ts b/scripts/lib/getPackageRegistryVersions.ts
@@ -2,12 +2,12 @@ import chalk from 'chalk'
 import pLimit from 'p-limit'
 
 import { getPackageDetails } from './getPackageDetails.js'
-import { packageWhitelist } from './whitelist.js'
+import { packagePublishList } from './publishList.js'
 
 const npmRequestLimit = pLimit(40)
 
 export const getPackageRegistryVersions = async (): Promise<void> => {
-  const packageDetails = await getPackageDetails(packageWhitelist)
+  const packageDetails = await getPackageDetails(packagePublishList)
 
   const results = await Promise.all(
     packageDetails.map(async (pkg) =>

diff --git a/scripts/lib/getWorkspace.ts b/scripts/lib/getWorkspace.ts
@@ -9,7 +9,7 @@ import path from 'path'
 import semver from 'semver'
 
 import { getPackageDetails } from './getPackageDetails.js'
-import { packageWhitelist } from './whitelist.js'
+import { packagePublishList } from './publishList.js'
 
 const filename = fileURLToPath(import.meta.url)
 const dirname = path.dirname(filename)
@@ -69,7 +69,7 @@ export const getWorkspace = async () => {
 
   // Publish one package at a time
   const publishSync: Workspace['publishSync'] = async ({ dryRun, tag = 'canary' }) => {
-    const packageDetails = await getPackageDetails(packageWhitelist)
+    const packageDetails = await getPackageDetails(packagePublishList)
     const results: PublishResult[] = []
     for (const pkg of packageDetails) {
       // TODO: Remove hard-coded dry-run
@@ -93,7 +93,7 @@ export const getWorkspace = async () => {
   }
 
   const publish = async () => {
-    const packageDetails = await getPackageDetails(packageWhitelist)
+    const packageDetails = await getPackageDetails(packagePublishList)
     const results = await Promise.allSettled(
       packageDetails.map((pkg) => publishPackageThrottled(pkg, { dryRun: true })),
     )
@@ -122,7 +122,7 @@ export const getWorkspace = async () => {
     packages: PackageDetails[]
     version: string
   }> => {
-    const packageDetails = await getPackageDetails(packageWhitelist)
+    const packageDetails = await getPackageDetails(packagePublishList)
     const rootPackageJson = await fse.readJSON(rootPackageJsonPath)
     return { packages: packageDetails, version: rootPackageJson.version }
   }
@@ -139,7 +139,7 @@ export const getWorkspace = async () => {
     rootPackageJson.version = version
     await fse.writeJSON(rootPackageJsonPath, rootPackageJson, { spaces: 2 })
 
-    const packageJsons = await getPackageDetails(packageWhitelist)
+    const packageJsons = await getPackageDetails(packagePublishList)
     await Promise.all(
       packageJsons.map(async (pkg) => {
         const packageJson = await fse.readJSON(`${pkg.packagePath}/package.json`)
@@ -173,7 +173,7 @@ export const getWorkspace = async () => {
   const workspace: Workspace = {
     version: async () => (await fse.readJSON(rootPackageJsonPath)).version,
     tag: 'latest',
-    packages: await getPackageDetails(packageWhitelist),
+    packages: await getPackageDetails(packagePublishList),
     showVersions,
     bumpVersion,
     build,

diff --git a/scripts/lib/whitelist.ts → scripts/lib/publishList.ts b/scripts/lib/whitelist.ts → scripts/lib/publishList.ts
@@ -1,5 +1,9 @@
-// Update this list with any packages to publish
-export const packageWhitelist = [
+/**
+ * Packages that should be published to NPM
+ *
+ * Note that this does not include all packages in the monorepo
+ */
+export const packagePublishList = [
   'payload',
   'translations',
   'ui',

diff --git a/scripts/publish-canary.ts b/scripts/publish-canary.ts
@@ -17,7 +17,7 @@ import type { PackageDetails } from './lib/getPackageDetails.js'
 import { getPackageDetails } from './lib/getPackageDetails.js'
 import { getPackageRegistryVersions } from './lib/getPackageRegistryVersions.js'
 import { getWorkspace } from './lib/getWorkspace.js'
-import { packageWhitelist } from './lib/whitelist.js'
+import { packagePublishList } from './lib/publishList.js'
 import { getRecommendedBump } from './utils/getRecommendedBump.js'
 import { updateChangelog } from './utils/updateChangelog.js'
 

diff --git a/scripts/release.ts b/scripts/release.ts
@@ -16,7 +16,7 @@ import type { PackageDetails } from './lib/getPackageDetails.js'
 
 import { getPackageDetails } from './lib/getPackageDetails.js'
 import { getPackageRegistryVersions } from './lib/getPackageRegistryVersions.js'
-import { packageWhitelist } from './lib/whitelist.js'
+import { packagePublishList } from './lib/publishList.js'
 import { getRecommendedBump } from './utils/getRecommendedBump.js'
 import { updateChangelog } from './utils/updateChangelog.js'
 
@@ -143,7 +143,7 @@ async function main() {
   console.log(chalk.gray(changelogContent) + '\n\n')
   console.log(`Release URL: ${chalk.dim(releaseUrl)}`)
 
-  let packageDetails = await getPackageDetails(packageWhitelist)
+  let packageDetails = await getPackageDetails(packagePublishList)
 
   console.log(chalk.bold(`\n  Version: ${monorepoVersion} => ${chalk.green(nextReleaseVersion)}\n`))
   console.log(chalk.bold.yellow(`  Bump: ${bump}`))