Merge pull request #159 from iterative/update-for-iterative-ai

Author: yathomasi

.github/workflows/check-deployment.yml

@@ -0,0 +1,29 @@
+name: Check Deployment
+on:
+  workflow_call:
+    inputs:
+      passci:
+        description: 'Pass CI'
+        required: true
+        type: boolean
+  workflow_dispatch:
+    inputs:
+      passci:
+        description: 'Pass CI'
+        required: true
+        type: boolean
+  pull_request:
+    types: [opened, synchronize, reopened, labeled]
+
+jobs:
+  check-branches:
+    if:
+      startsWith(github.head_ref, 'renovate/') || contains(github.head_ref,
+      'no-deploy')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Fail if no passci inputs or pass-ci label
+        if:
+          ${{ !inputs.passci &&
+          !contains(github.event.pull_request.labels.*.name, 'pass-ci') }}
+        run: exit 1

packages/example/gatsby-config.js

@@ -16,7 +16,8 @@ module.exports = {
       resolve: themePackageName,
       options: {
         simpleLinkerTerms: require('./content/linked-terms'),
-        plausibleSrc: null
+        plausibleSrc: null,
+        sentry: false
       }
     },
     {
@@ -25,7 +26,6 @@ module.exports = {
         name: 'images',
         path: path.join(__dirname, 'static', 'img')
       }
-    },
-    '@sentry/gatsby'
+    }
   ]
 }

packages/example/sentry.config.js

@@ -117,40 +117,17 @@ others in the future.
   This is the prefix that the docs pages will render to, including the index
   page at the exact path.
 
+- sentry: boolean
+
+  Default: true
+
+  If true, this theme will instantiate `@sentry/gatsby` with a default
+  configuration. This configuration can be imported from `sentry-config.js` and
+  overridden by creating a
+  [Sentry configuration file](https://docs.sentry.io/platforms/javascript/guides/gatsby/#sentry-configuration-file)
+  in your project's root.
+
 ### Examples
 
-See this example from
-[the example website's `gatsby-config.js`](https://github.com/iterative/gatsby-theme-iterative/blob/main/packages/example/gatsby-config.js).
-
-```js
-const path = require('path')
-const {
-  name: themePackageName
-} = require('../gatsby-theme-iterative/package.json')
-
-module.exports = {
-  trailingSlash: 'never',
-  siteMetadata: {
-    title: 'Example website',
-    description: 'Example website description',
-    keywords: ['docs', 'test'],
-    siteUrl: 'http://localhost:8000'
-  },
-  plugins: [
-    {
-      resolve: themePackageName,
-      options: {
-        simpleLinkerTerms: require('./content/linked-terms')
-      }
-    },
-    {
-      resolve: 'gatsby-source-filesystem',
-      options: {
-        name: 'images',
-        path: path.join(__dirname, 'static', 'img')
-      }
-    },
-    '@sentry/gatsby'
-  ]
-}
-```
+Check out the example project in this project's monorepo, particularly
+[`gatsby-config.js`](https://github.com/iterative/gatsby-theme-iterative/blob/main/packages/example/gatsby-config.js).

packages/gatsby-theme-iterative/README.md

@@ -5,5 +5,6 @@ module.exports = {
   docsInstanceName: 'iterative-docs',
   glossaryPath: path.resolve('content', 'docs', 'user-guide', 'basic-concepts'),
   glossaryInstanceName: 'iterative-glossary',
-  argsLinkerPath: ['command-reference', `ref`, 'cli-reference']
+  argsLinkerPath: ['command-reference', `ref`, 'cli-reference'],
+  sentry: true
 }

packages/gatsby-theme-iterative/config-defaults.js

@@ -17,6 +17,7 @@ require('./config/prismjs/dvctable')
 const imageMaxWidth = 700
 
 const defaults = require('./config-defaults')
+const sentryConfig = require('./sentry-config')
 
 module.exports = ({
   simpleLinkerTerms,
@@ -32,7 +33,8 @@ module.exports = ({
   docsPath = defaults.docsPath,
   glossaryInstanceName = defaults.glossaryInstanceName,
   glossaryPath = defaults.glossaryPath,
-  argsLinkerPath = defaults.argsLinkerPath
+  argsLinkerPath = defaults.argsLinkerPath,
+  sentry = defaults.sentry
 }) => ({
   plugins: [
     {
@@ -135,7 +137,8 @@ module.exports = ({
           },
           'gatsby-remark-responsive-iframe',
           require.resolve('./plugins/resize-image-plugin'),
-          require.resolve('./plugins/external-link-plugin')
+          require.resolve('./plugins/external-link-plugin'),
+          require.resolve('./plugins/null-link-plugin')
         ]
       }
     },
@@ -153,6 +156,10 @@ module.exports = ({
           placeholder: 'blurred'
         }
       }
+    },
+    sentry && {
+      resolve: '@sentry/gatsby',
+      options: sentryConfig
     }
   ].filter(Boolean),
   siteMetadata: {

packages/gatsby-theme-iterative/gatsby-config.js

@@ -23,7 +23,7 @@ exports.pluginOptionsSchema = ({ Joi }) => {
     glossaryInstanceName: Joi.string()
       .default('iterative-glossary')
       .allow(false),
-    docsInstanceName: Joi.string().default('iterative-docs'),
+    docsInstanceName: Joi.string().default('iterative-docs').allow(false),
     docsPrefix: Joi.string().default('doc'),
     simpleLinkerTerms: Joi.array().items(
       Joi.object({
@@ -37,7 +37,8 @@ exports.pluginOptionsSchema = ({ Joi }) => {
       .default(defaults.argsLinkerPath),
     plausibleSrc: [Joi.string().optional(), Joi.allow(null)],
     plausibleAPI: [Joi.string().optional(), Joi.allow(null)],
-    plausibleDomain: [Joi.string().optional(), Joi.allow(null)]
+    plausibleDomain: [Joi.string().optional(), Joi.allow(null)],
+    sentry: Joi.boolean().default(defaults.sentry)
   })
 }
 

packages/gatsby-theme-iterative/gatsby-node.js

@@ -1,6 +1,6 @@
 {
   "name": "@dvcorg/gatsby-theme-iterative",
-  "version": "0.2.6",
+  "version": "0.2.9-beta.0",
   "description": "",
   "main": "index.js",
   "types": "src/typings.d.ts",

packages/gatsby-theme-iterative/package.json

@@ -0,0 +1,9 @@
+module.exports = async ({ markdownAST }) => {
+  const { visit } = await import('unist-util-visit')
+  visit(markdownAST, 'link', node => {
+    if (!node.url && node?.children?.[0]?.type === 'inlineCode') {
+      node.type = 'inlineCode'
+      node.value = node.children[0].value
+    }
+  })
+}

packages/gatsby-theme-iterative/plugins/null-link-plugin/index.js

@@ -0,0 +1,7 @@
+{
+  "name": "null-link-plugin",
+  "version": "1.0.0",
+  "main": "index.js",
+  "author": "yathomasi",
+  "license": "Apache-2.0"
+}