diff --git a/src/codeql-cli/lib/config.json b/src/codeql-cli/lib/config.json index f5ad763ce1..eef69593b2 100644 --- a/src/codeql-cli/lib/config.json +++ b/src/codeql-cli/lib/config.json @@ -15,6 +15,7 @@ "product": "{% data reusables.gated-features.codeql %}", "autogenerated": "codeql-cli" }, + "markdownPrefix": "{% data reusables.codeql-cli.man-pages-version-note %}", "targetDirectory": "content/code-security/codeql-cli/codeql-cli-manual", "sourceDirectory": "semmle-code/documentation/restructuredtext/codeql-cli/manual", "removeKeywords": [], diff --git a/src/codeql-cli/scripts/sync.js b/src/codeql-cli/scripts/sync.js index 84c3f0ad7f..047db1dd1d 100755 --- a/src/codeql-cli/scripts/sync.js +++ b/src/codeql-cli/scripts/sync.js @@ -17,9 +17,8 @@ import { toMarkdown } from 'mdast-util-to-markdown' import { languageKeys } from '../../../lib/languages.js' -const { targetDirectory, sourceDirectory, frontmatterDefaults, removeKeywords } = JSON.parse( - await readFile(path.join('src/codeql-cli/lib/config.json'), 'utf-8') -) +const { targetDirectory, sourceDirectory, frontmatterDefaults, removeKeywords, markdownPrefix } = + JSON.parse(await readFile(path.join('src/codeql-cli/lib/config.json'), 'utf-8')) const RELATIVE_LINK_PATH = targetDirectory.replace('content', '') const SOURCE_REPO = sourceDirectory.split('/')[0] const TEMP_DIRECTORY = path.join(SOURCE_REPO, 'tempCliDocs') @@ -255,7 +254,7 @@ async function main() { // write the Markdown file const targetFilename = path.join(targetDirectory, path.basename(file)) - const markdownContent = MARKDOWN_COMMENT + toMarkdown(ast) + const markdownContent = MARKDOWN_COMMENT + `${markdownPrefix}\n\n` + toMarkdown(ast) await writeFile(targetFilename, matter.stringify(markdownContent, frontmatter)) }