You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucenenet.apache.org by ni...@apache.org on 2021/03/24 03:35:42 UTC
[lucenenet] 02/04: docs: Added workaround for DocFx not updating a
version number within a fenced code block by updating the lucene-cli index
file in Powershell
This is an automated email from the ASF dual-hosted git repository.
nightowl888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git
commit 106279a54fd43161c55e570f1b0d90212ac1a689
Author: Shad Storhaug <sh...@shadstorhaug.com>
AuthorDate: Wed Mar 24 09:37:43 2021 +0700
docs: Added workaround for DocFx not updating a version number within a fenced code block by updating the lucene-cli index file in Powershell
---
websites/apidocs/docs.ps1 | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/websites/apidocs/docs.ps1 b/websites/apidocs/docs.ps1
index 8f4c422..feb5080 100644
--- a/websites/apidocs/docs.ps1
+++ b/websites/apidocs/docs.ps1
@@ -1,4 +1,4 @@
-# -----------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------------
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
@@ -51,6 +51,7 @@ $PSScriptFilePath = (Get-Item $MyInvocation.MyCommand.Path).FullName
$RepoRoot = (get-item $PSScriptFilePath).Directory.Parent.Parent.FullName;
$ApiDocsFolder = Join-Path -Path $RepoRoot -ChildPath "websites\apidocs";
$ToolsFolder = Join-Path -Path $ApiDocsFolder -ChildPath "tools";
+$CliIndexPath = Join-Path -Path $RepoRoot -ChildPath "src\dotnet\tools\lucene-cli\docs\index.md";
#ensure the /build/tools folder
New-Item $ToolsFolder -type directory -force
@@ -183,6 +184,10 @@ if ($? -and $DisableMetaData -eq $false) {
}
if ($? -and $DisableBuild -eq $false) {
+ # HACK: DocFx doesn't seem to work with fenced code blocks, so we update the lucene-cli index file manually.
+ # Note it works better this way anyway because we can store a real version number in the file in the repo.
+ (Get-Content -Path $CliIndexPath -Raw) -Replace '(?<=--version\s)\d+?\.\d+?\.\d+?(?:\.\d+?)?(?:-\w+)?', $LuceneNetVersion | Set-Content -Path $CliIndexPath
+
foreach ($proj in $DocFxJsonMeta) {
$projFile = Join-Path -Path $ApiDocsFolder $proj