lucenenet-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [lucenenet] NightOwl888 commented on issue #396: Idea on how to handle manually editing the docs files while keeping the automated conversion
Date Thu, 26 Nov 2020 17:31:13 GMT

NightOwl888 commented on issue #396:
URL: https://github.com/apache/lucenenet/issues/396#issuecomment-734417702


   I have converted the `JavaToMarkdownConverter` to a dotnet tool (currently at https://github.com/NightOwl888/lucenenet-javadoc2markdown)
simply named `javadoc2markdown` and set up an official NuGet feed to download it from at https://dev.azure.com/lucene-net/Lucene.NET/_packaging?_a=feed&feed=lucene-net-tools
   
   To install the latest version of the tool in the scripts to a local path, just run the
command:
   
   ```
   dotnet tool install javadoc2markdown --add-source https://pkgs.dev.azure.com/lucene-net/_packaging/lucene-net-tools/nuget/v3/index.json
--tool-path ./
   ```
   
   Then run the command:
   
   ```
   javadoc2markdown <LUCENE DIRECTORY> <LUCENENET DIRECTORY>
   ```
   The parameters are exactly the same as they were before.
   
   Then to clean up, run the command:
   
   ```
   dotnet tool uninstall javadoc2markdown --tool-path ./
   ```
   
   You might want to put that last line in a finally block to ensure the script is re-runnable
in the case of an exception.
   
   The GitHub repo is only meant to be temporary until an Apache repo is set up for it. I
haven't yet removed the tool from this repo, but I suggest to do so and update the scripts
before doing any branching. 
   
   The changes I made are enough to decouple the docs build scripts from any specific version
of the tool, but the `JavaDoc2Markdown` tool's build and upload to the feed could be fully
automated by referencing `Nerdbank.GitVersioning` and copying the `azure-pipelines.yml` and
related files from [Morfologik.Stemming](https://github.com/NightOwl888/Morfologik.Stemming)
(minus the test stage, we don't need that). We would also need to remove some of the [custom
settings](https://github.com/dotnet/Nerdbank.GitVersioning/blob/master/doc/nbgv-cli.md#customizing-the-behaviour-of-prepare-release)
from the `version.json` file, which is what configures `Nerdbank.GitVersioning` and remove
the explicit `<Version>` property from the project file.
   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



Mime
View raw message