Merge branch 'main' into main

Author: f22hd

.github/CODEOWNERS

@@ -1,2 +1,2 @@
-*                 @netlify/netlify-dev @netlify/workflow
-docs/             @netlify/docs
+*                 @netlify/ecosystem-pod-integrations
+docs/             @netlify/department-docs

.github/workflows/fossa.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Download fossa cli
         run: |-
           mkdir -p $HOME/.local/bin

.github/workflows/release-please.yml

@@ -7,20 +7,20 @@ jobs:
   release-please:
     runs-on: ubuntu-latest
     steps:
-      - uses: navikt/github-app-token-generator@a9cd374e271b8aef573b8c16ac46c44fb89b02db
+      - uses: navikt/github-app-token-generator@a8ae52448279d468cfbca5cd899f2457f0b1f643
         id: get-token
         with:
           private-key: ${{ secrets.TOKENS_PRIVATE_KEY }}
           app-id: ${{ secrets.TOKENS_APP_ID }}
-      - uses: GoogleCloudPlatform/release-please-action@v3
+      - uses: GoogleCloudPlatform/release-please-action@v4
         id: release
         with:
           token: ${{ steps.get-token.outputs.token }}
           release-type: node
           package-name: '@netlify/plugins-list'
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         if: ${{ steps.release.outputs.release_created }}
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: '*'
           cache: 'npm'

.github/workflows/sync-cms-to-repo.yml

@@ -0,0 +1,35 @@
+name: Sync CMS to Plugins Repository
+on:
+  repository_dispatch:
+    # sync_cms_to_repo is a bespoke type created for use with the CMS Webhook
+    types: [sync_cms_to_repo]
+jobs:
+  sync-to-repo:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@v4
+      - name: Using Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '*'
+          cache: 'npm'
+          check-latest: true
+      - name: Install dependencies
+        run: npm install
+      - name: Setup git config
+        run: |
+          git config user.name 'token-generator-app[bot]'
+          git config user.email '82042599+token-generator-app[bot]@users.noreply.github.com'
+      - name: Generate GitHub token
+        uses: navikt/github-app-token-generator@v1.2.1
+        id: get-token
+        with:
+          private-key: ${{ secrets.TOKENS_PRIVATE_KEY }}
+          app-id: ${{ secrets.TOKENS_APP_ID }}
+      - name: Sync CMS to repo
+        env:
+          GITHUB_TOKEN: ${{ steps.get-token.outputs.token }}
+          CMS_CHANGES: ${{ toJson(github.event.client_payload) }}
+
+        run: bin/sync_cms_to_repo.sh

.github/workflows/sync-to-cms.yml

@@ -0,0 +1,27 @@
+name: Sync Plugins to CMS
+on:
+  pull_request:
+    types:
+      - closed
+jobs:
+  sync-to-cms:
+    # Only run if the merged PR wasn't an automated PR for synching from the cms to the repo
+    if: github.event.pull_request.merged && !contains(github.event.pull_request.labels.*.name, 'cms_sync')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@v4
+      - name: Using Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '*'
+          cache: 'npm'
+          check-latest: true
+      - name: Install dependencies
+        run: npm install
+      - name: Sync plugins to CMS
+        env:
+          SANITY_API_TOKEN: ${{ secrets.SANITY_API_TOKEN }}
+          SANITY_PROJECT_ID: ${{ secrets.SANITY_PROJECT_ID }}
+          SANITY_DATASET: ${{ secrets.SANITY_DATASET }}
+        run: npx tsx bin/sync_plugins_to_cms.js

.github/workflows/test.yml

@@ -12,9 +12,9 @@ jobs:
     timeout-minutes: 30
     steps:
       - name: Git checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Using Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '*'
           cache: 'npm'

.github/workflows/versioning.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Git checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       # Updates the list-v* git tag to version `plugins.json`.
       # Consumers must use the tag-specific deploy URL:
       #   list-v*--netlify-plugins.netlify.app/plugins.json

.gitignore

@@ -10,3 +10,7 @@ node_modules
 /build
 .vscode
 .DS_Store
+.env
+
+# Local Netlify folder
+.netlify

CHANGELOG.md

@@ -2,20 +2,6 @@
 
 [Build Plugins](https://docs.netlify.com/configure-builds/build-plugins) are a new way to extend the functionality of your build on Netlify. The [`plugins.json` file](./site/plugins.json) in this repository is used to generate the [Netlify plugins directory](https://app.netlify.com/plugins). Plugins in this directory can be installed directly through the Netlify UI.
 
-## Contributing
-
-The Netlify Plugins directory is filled with plugins created by Netlify staff and members of the community like you. You can contribute to the directory in the following ways:
-
-- [Add a plugin](./docs/CONTRIBUTING.md#add-a-plugin) you've written to the plugins directory.
-- [Update a plugin](./docs/CONTRIBUTING.md#update-a-plugin) you maintain that's already in the directory.
-- [Request directory deactivation](./docs/CONTRIBUTING.md#request-deactivation) for a plugin which is not being maintained.
-
-Visit the repository [contributor guide](./docs/CONTRIBUTING.md) for details.
-
-## Plugin review
-
-If you're reviewing someone else's plugin, please check the following [document](docs/plugin_review.md).
-
 ## Code of Conduct
 
 This project and everyone participating in it is governed by a [code of conduct](./docs/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to conduct@netlify.com.

README.md

@@ -0,0 +1,16 @@
+import { promises as fs } from 'fs'
+
+import plugins from '../site/plugins.json'
+
+import { updatePlugins } from './utils.js'
+
+// eslint-disable-next-line n/prefer-global/process
+const changes = JSON.parse(process.env.CMS_CHANGES)
+
+console.log('Checking for CMS updates...')
+console.log('Changes to synchronize', changes)
+console.log('Synchronizing changes to plugins repo...')
+const updatedPlugins = updatePlugins(changes, plugins)
+fs.writeFile('site/plugins.json', `${JSON.stringify(updatedPlugins, null, 2)}\n`)
+
+console.log('Done synching CMS updates to plugins repo.')

bin/sync_cms_to_plugins_repo.js

@@ -0,0 +1,23 @@
+PR_TITLE="chore: cms to repo sync"
+BRANCH_NAME="sync_cms_to_plugins_$(date +%s)"
+
+git branch $BRANCH_NAME
+git switch $BRANCH_NAME
+
+echo "Syncing CMS to plugins"
+npx tsx bin/sync_cms_to_plugins_repo.js
+
+
+# This is the only file we want to commit
+git add site/plugins.json
+
+# See if we have any changes. We should.
+if [[ -n "$(git status --porcelain)" ]]; then
+  echo "Creating PR \"$PR_TITLE\" for branch $BRANCH_NAME"
+  git commit -m "$PR_TITLE"
+  git push origin $BRANCH_NAME
+  gh pr create --title "$PR_TITLE" --body "This is an automated PR to sync the CMS to the repo" --label "cms_sync" --label "automerge"
+else
+  # Shouldn't end up here, but log that there was nothing to sync
+  echo "Looks like there was nothing to sync."
+fi

bin/sync_cms_to_repo.sh

@@ -0,0 +1,137 @@
+// eslint-env node
+/* eslint-disable n/prefer-global/process */
+import { promises as fs } from 'fs'
+import path from 'path'
+
+import sanityClient from '@sanity/client'
+import { uuid } from '@sanity/uuid'
+
+// when testing this script locally, add a path in your .env for GITHUB_WORKSPACE or pass it in
+// e.g. GITHUB_WORKSPACE="$(pwd)" npx tsx bin/sync_plugins_to_cms.js
+
+/**
+ * @typedef { import("../types/plugins").SanityBuildPluginEntity } SanityBuildPluginEntity
+ * @typedef { import("@sanity/client").SanityClient } SanityClient
+ * @typedef { import("@sanity/client").Transaction } Transaction
+ * @typedef { import("@sanity/client").Patch } Patch
+ * @typedef { import("../types/plugins").BuildPluginEntity } BuildPluginEntity
+ */
+
+import { getPluginDiffsForSanity, getSanityPluginLookup } from './utils.js'
+
+if (process.env.NODE_ENV === 'development') {
+  // Using dotenv for local development.
+  console.log('running in development mode')
+
+  const dotenv = await import('dotenv')
+  dotenv.config()
+}
+
+const { GITHUB_WORKSPACE, SANITY_API_TOKEN, SANITY_PROJECT_ID, SANITY_DATASET } = process.env
+const [apiVersion] = new Date().toISOString().split('T')
+
+const config = {
+  projectId: SANITY_PROJECT_ID,
+  dataset: SANITY_DATASET,
+  apiVersion,
+  token: SANITY_API_TOKEN,
+  // make sure we have the freshest data when doing the diff with plugins.json
+  useCdn: false,
+}
+
+/**
+ * Creates a transaction containing updates to plugins for the CMS
+ *
+ * @param {Transaction} transaction
+ * @param {Patch} patch
+ * @param {BuildPluginEntity[]} diffs
+ * @returns
+ */
+const createUpdates = (transaction, patch, diffs) =>
+  diffs.reduce((tx, plugin) => {
+    const { _id, ...changes } = plugin
+    const fieldUpdates = {}
+    const fieldRemovals = []
+
+    for (const [key, value] of Object.entries(changes)) {
+      // any property that is null needs to be unset instead of being set to null
+      if (value === null) {
+        fieldRemovals.push(key)
+      } else {
+        fieldUpdates[key] = value
+      }
+    }
+
+    const update = patch(_id).set(fieldUpdates)
+
+    if (fieldRemovals.length !== 0) {
+      update.unset(fieldRemovals)
+    }
+
+    tx.patch(update)
+
+    return tx
+  }, transaction)
+
+/**
+ * @type {SanityClient}
+ */
+const client = sanityClient(config)
+
+// These are the only fields to synch for the moment.
+const query = `*[_type == "buildPlugin"] {
+  _id,
+  packageName,
+  version,
+  compatibility[]
+}`
+
+// TODO: Add a retry mechanism to handle network errors
+try {
+  const pluginsFilePath = path.join(GITHUB_WORKSPACE, '/site/plugins.json')
+  const fileContents = await fs.readFile(pluginsFilePath)
+  const plugins = JSON.parse(fileContents).map((plugin) => {
+    // Ensure if a compatibility field exists, that it has all the necessary fields to sync with Sanity
+    if (plugin.compatibility) {
+      // eslint-disable-next-line no-param-reassign
+      plugin.compatibility = plugin.compatibility.map((compatibilityItem) => {
+        const updatedCompatibilityItem = {
+          // A _key property is required by Sanity so each array item can be identified in a collaborative way
+          // See https://www.sanity.io/docs/array-type#92296c6c45ea
+          _key: uuid(),
+          ...compatibilityItem,
+        }
+
+        return updatedCompatibilityItem
+      })
+    }
+
+    return plugin
+  })
+
+  console.info('Detecting plugin changes...')
+
+  /**
+   * @type {SanityBuildPluginEntity[]}
+   */
+  const sanityBuildPlugins = await client.fetch(query, {})
+  const sanityPluginLookup = await getSanityPluginLookup(sanityBuildPlugins)
+  const pluginDiffs = getPluginDiffsForSanity(sanityPluginLookup, plugins)
+
+  if (pluginDiffs.length === 0) {
+    console.info('No plugin changes found.')
+  } else {
+    console.info(`Found ${pluginDiffs.length} plugins with changes`)
+    console.info('Updating plugins...')
+
+    const transaction = createUpdates(client.transaction(), client.patch, pluginDiffs)
+
+    client.mutate(transaction)
+    console.info('Plugins were updated in the CMS.')
+  }
+} catch (error) {
+  console.error(error)
+  throw new Error('Unable to synchronize plugins to the CMS')
+}
+
+/* eslint-enable n/prefer-global/process */