[ci] build next docs in PRs when relevant files change (#149991)

After chatting with @KOTungseth, @scottybollinger, and @glitteringkatie we've decided to add a CI step to the Kibana repo that will run when changes to next-doc related code is made. This step will checkout the repository containing configuration for the docs.elastic.dev website (which is currently private, sorry) and then ensure that the build can be completed with a local copy of all the repositories. It does this by reading the `config/content.js` files and cloning all of the repositories listed, then rewriting the content.js file with a map telling the build system to read files from the local repos (which are pre-cached by the packer cache job) and the local Kibana repo (which represents the changes in the PR). This script also runs locally by running `node scripts/validate_next_docs`. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2025-06-28 11:05:39 -04:00 · 2023-02-09 21:57:10 -07:00 · 2023-02-09 21:57:10 -07:00 · a1c55c6f13
commit a1c55c6f13
parent b53d48348c
20 changed files with 459 additions and 0 deletions
--- a/packages/kbn-validate-next-docs-cli/validate_next_docs_cli.ts
+++ b/packages/kbn-validate-next-docs-cli/validate_next_docs_cli.ts
@ -0,0 +1,84 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { run } from '@kbn/dev-cli-runner';
+import { createFailError } from '@kbn/dev-cli-errors';
+import { REPO_ROOT } from '@kbn/repo-info';
+
+import { Repos } from './repos';
+import { Config, Source } from './config';
+import { quietFail } from './error';
+
+run(
+  async ({ log, flagsReader }) => {
+    const cloneOnly = flagsReader.boolean('clone-only');
+
+    const repos = new Repos(log);
+    const docsRepo = await repos.init('elastic/docs.elastic.dev');
+    const contentConfig = new Config(docsRepo);
+    const sources = contentConfig.getSources().filter((s) => s.location !== 'elastic/kibana');
+
+    if (sources.some((s) => s.type !== 'github')) {
+      throw createFailError(
+        'expected all content.js sources from docs.elastic.dev to have "type: github"'
+      );
+    }
+
+    const localCloneSources = await Promise.all(
+      sources.map(async (source): Promise<Source> => {
+        const repo = await repos.init(source.location);
+
+        return {
+          type: 'file',
+          location: repo.resolve(),
+        };
+      })
+    );
+
+    if (cloneOnly) {
+      log.success('cloned repos');
+      return;
+    }
+
+    log.info('[docs.elastic.dev] updated sources to point to local repos');
+    contentConfig.setSources([
+      ...localCloneSources,
+      {
+        type: 'file',
+        location: REPO_ROOT,
+      },
+    ]);
+
+    const showOutput = flagsReader.boolean('debug') || flagsReader.boolean('verbose');
+    try {
+      log.info('[docs.elastic.dev] installing deps with yarn');
+      await docsRepo.run('yarn', [], { desc: 'yarn install', showOutput });
+
+      log.info('[docs.elastic.dev] initializing docsmobile');
+      await docsRepo.run('yarn', ['docsmobile', 'init'], {
+        desc: 'yarn docsmobile init',
+        showOutput,
+      });
+
+      log.info('[docs.elastic.dev] building');
+      await docsRepo.run('yarn', ['build'], { desc: 'yarn build', showOutput });
+    } catch {
+      quietFail(`failed to build docs`);
+    }
+
+    log.success('docs built successfully');
+  },
+  {
+    flags: {
+      boolean: ['clone-only'],
+      help: `
+        --clone-only       Simply clone the repos, used to populate the worker images
+      `,
+    },
+  }
+);