You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucenenet.apache.org by "paulirwin (via GitHub)" <gi...@apache.org> on 2024/09/22 17:19:46 UTC
[PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
paulirwin opened a new pull request, #961:
URL: https://github.com/apache/lucenenet/pull/961
<!-- Thank you for submitting a pull request to our repo. -->
<!-- Please do NOT submit PRs for features in newer versions of Lucene. We should keep the target version consistent across our repository to make the upgrade process to newer versions of Lucene go smoothly. -->
<!-- If this is your first PR in the Lucene.NET repo, please run through the checklist
below to ensure a smooth review and merge process for your PR. -->
- [X] You've read the [Contributor Guide](https://github.com/apache/lucenenet/blob/main/CONTRIBUTING.md) and [Code of Conduct](https://www.apache.org/foundation/policies/conduct.html).
- [ ] You've included unit or integration tests for your change, where applicable.
- [ ] You've included inline docs for your change, where applicable.
- [X] There's an open issue for the PR that you are making. If you'd like to propose a change, please [open an issue](https://github.com/apache/lucenenet/issues/new/choose) to discuss the change or find an existing issue.
<!-- Once all that is done, you're ready to go. Open the PR with the content below. -->
This PR fixes several issues with the API docs and upgrades docfx.
Fixes #911
Thanks to @nikcio for the assistance.
## Description
- docfx has been upgraded to the latest version (2.77) and now runs successfully on macOS
- docfx is now installed as a dotnet global tool, and the installation is skipped if already installed
- Post-processors have been upgraded to use the latest docfx SDK
- Several documentation build warnings have been resolved due to invalid type references
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2403983400
@NightOwl888 I converted your comment above into a checklist, and I'm checking off those issues as I go. Several of them have been resolved. Notably, I had to work around those homepage links going to test-framework by intentionally not including the test-framework xrefmap in the top-level API docs docfx.site.json, and linking to it manually instead. No amount of reordering the xrefmaps array seemed to make a difference. Unless we want to change those namespaces in TestFramework to not conflict with those in Core, I think we'll need to live with this workaround for now.
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2403809672
:warning: **IMPORTANT:** This PR may contain changes to dependency versions. The GitHub Actions test runner is not set up to detect dependency version conflicts between projects. To ensure the changes do not cause dependency conflicts, [run the tests for these changes in Azure DevOps](https://github.com/apache/lucenenet#azure-devops) before accepting this pull request. :warning:
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on code in PR #961:
URL: https://github.com/apache/lucenenet/pull/961#discussion_r1770633152
##########
src/dotnet/tools/lucene-cli/docs/index.md:
##########
@@ -11,7 +11,7 @@ The Lucene.NET command line interface (CLI) is a new cross-platform toolchain wi
Perform a one-time install of the lucene-cli tool using the following dotnet CLI command:
```console
-dotnet tool install lucene-cli -g --version 4.8.0-beta00016
+dotnet tool install lucene-cli -g --version EnvVar:LuceneNetVersion
Review Comment:
I went ahead and pushed that up in case you approve of that change.
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2408607178
:warning: **IMPORTANT:** This PR may contain changes to dependency versions. The GitHub Actions test runner is not set up to detect dependency version conflicts between projects. To ensure the changes do not cause dependency conflicts, [run the tests for these changes in Azure DevOps](https://github.com/apache/lucenenet#azure-devops) before accepting this pull request. :warning:
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2403824702
:warning: **IMPORTANT:** This PR may contain changes to dependency versions. The GitHub Actions test runner is not set up to detect dependency version conflicts between projects. To ensure the changes do not cause dependency conflicts, [run the tests for these changes in Azure DevOps](https://github.com/apache/lucenenet#azure-devops) before accepting this pull request. :warning:
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2366885025
:warning: **IMPORTANT:** This PR may contain changes to dependency versions. The GitHub Actions test runner is not set up to detect dependency version conflicts between projects. To ensure the changes do not cause dependency conflicts, [run the tests for these changes in Azure DevOps](https://github.com/apache/lucenenet#azure-devops) before accepting this pull request. :warning:
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on code in PR #961:
URL: https://github.com/apache/lucenenet/pull/961#discussion_r1770623001
##########
src/Lucene.Net.Highlighter/Highlight/WeightedSpanTermExtractor.cs:
##########
@@ -58,7 +58,7 @@ public WeightedSpanTermExtractor(string defaultField)
}
/// <summary>
- /// Fills a <see cref="T:IDictionary{string, WeightedSpanTerm}"/> with <see cref="WeightedSpanTerm"/>s using the terms from the supplied <paramref name="query"/>.
+ /// Fills a <see cref="T:IDictionary{string,WeightedSpanTerm}"/> with <see cref="WeightedSpanTerm"/>s using the terms from the supplied <paramref name="query"/>.
Review Comment:
I've already done the work of removing the warnings related to these, so at this point I don't think we need to solve that future problem in this PR, so we could open an issue if someone wants to look into that.
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2405161131
Yeah, it's more than just the RandomExtensions though. TestFramework has types in the Analysis, Codecs, and Search namespaces that conflict with the links on the homepage. Basically, a `xref:Lucene.Net.Search` is finding the test-framework version first always, for some reason. We would have to change all of those types to not conflict, or dig into the docfx source and figure out what the problem is, possibly having to submit a PR to docfx to fix it unless we're doing something wrong as of the latest versions. It seemed to me that just specifying a URL by hand was an easier fix for now.
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2403841827
:warning: **IMPORTANT:** This PR may contain changes to dependency versions. The GitHub Actions test runner is not set up to detect dependency version conflicts between projects. To ensure the changes do not cause dependency conflicts, [run the tests for these changes in Azure DevOps](https://github.com/apache/lucenenet#azure-devops) before accepting this pull request. :warning:
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2408637577
Want me to downgrade to 22.04 for now?
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "rclabo (via GitHub)" <gi...@apache.org>.
rclabo commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2409079198
> I agree this is an improvement as there are many more links that now resolve that didn't previously than links that no longer resolve. All said, there is nothing critical I can see that is so urgent as to hold up the release.
>
> If you wish to address any of the above issues, feel free, but this is fine to merge.
This perspective made me very happy.
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2408227805
:warning: **IMPORTANT:** This PR may contain changes to dependency versions. The GitHub Actions test runner is not set up to detect dependency version conflicts between projects. To ensure the changes do not cause dependency conflicts, [run the tests for these changes in Azure DevOps](https://github.com/apache/lucenenet#azure-devops) before accepting this pull request. :warning:
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2408639491
I'm adding a message to communicate when it's restoring the docfx tool, which was the hang you saw.
Regarding the "Improve this doc" link, that goes to my fork on my machine, so I think this might be okay when built against the main repo.
I have added the remaining issues as #969
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin merged PR #961:
URL: https://github.com/apache/lucenenet/pull/961
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2406196704
:warning: **IMPORTANT:** This PR may contain changes to dependency versions. The GitHub Actions test runner is not set up to detect dependency version conflicts between projects. To ensure the changes do not cause dependency conflicts, [run the tests for these changes in Azure DevOps](https://github.com/apache/lucenenet#azure-devops) before accepting this pull request. :warning:
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "NightOwl888 (via GitHub)" <gi...@apache.org>.
NightOwl888 commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2408641329
> Want me to downgrade to 22.04 for now?
This will need to be propagated to all of our builds that are using .NET 5, both on GitHub Actions and Azure DevOps. I noticed .NET 5 failures earlier with ICU4N, but now that I am seeing them here it makes sense. Yes, I think the quickest solution would be to pin the OS version for the .NET 5 tests, but we should probably update both CI builds in a separate PR.
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2408641612
Sounds good, I'll do that in a separate PR.
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2408260665
Alright all but issue 14 are resolved, not sure what's up with that. I resolved several xref map warnings/issues. There are a few xrefs that are not causing build warnings that aren't getting made into links for some reason, not sure why. An example are the ones on the OpenNLP overview page. But this is a great improvement so far. I think we can break out some of these issues separately. The primary issue (that docs cannot build) is resolved, and several doc issues have been fixed in this PR, so I think it's largely a net improvement. @NightOwl888 please review and let me know if this is good to merge, with breaking out the remaining issues.
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "NightOwl888 (via GitHub)" <gi...@apache.org>.
NightOwl888 commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2408626190
Here it is: https://github.com/actions/runner-images/issues/10636. Looks like that is exactly what the issue is, as they are rolling that change out now.
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "NightOwl888 (via GitHub)" <gi...@apache.org>.
NightOwl888 commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2408615510
Hold up, it looks like lots of tests failed on Linux. I think it is a transient CI issue, though. I am going to try re-running them.
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "NightOwl888 (via GitHub)" <gi...@apache.org>.
NightOwl888 commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2404015076
> Unless we want to change those namespaces in TestFramework to not conflict with those in Core, I think we'll need to live with this workaround for now.
I don't recall exactly why the extension methods were placed in the `Lucene.Net` namespace. We have generally been using an `XXX.Extensions` namespace to put them in so users have the ability to opt out if there is a conflict with other extension methods with the same signature. But it is probably best that we don't change it until we properly analyze it. Sometimes it is a better UX if they "just work" without importing namespaces.
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2408260018
:warning: **IMPORTANT:** This PR may contain changes to dependency versions. The GitHub Actions test runner is not set up to detect dependency version conflicts between projects. To ensure the changes do not cause dependency conflicts, [run the tests for these changes in Azure DevOps](https://github.com/apache/lucenenet#azure-devops) before accepting this pull request. :warning:
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2366881210
:warning: **IMPORTANT:** This PR may contain changes to dependency versions. The GitHub Actions test runner is not set up to detect dependency version conflicts between projects. To ensure the changes do not cause dependency conflicts, [run the tests for these changes in Azure DevOps](https://github.com/apache/lucenenet#azure-devops) before accepting this pull request. :warning:
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on code in PR #961:
URL: https://github.com/apache/lucenenet/pull/961#discussion_r1770624637
##########
src/dotnet/tools/lucene-cli/docs/index.md:
##########
@@ -44,3 +44,18 @@ CLI command structure consists of the driver ("lucene"), the command, and possib
lucene index check C:\my-index --verbose
lucene index fix C:\my-index
```
+
Review Comment:
The plugin should not be adding these, but I removed the extra lines for now. I'll go through and find the others, and I'm breaking out a new issue for fixing the appending the extra lines.
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "NightOwl888 (via GitHub)" <gi...@apache.org>.
NightOwl888 commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2408625347
The error is:
```
The active test run was aborted. Reason: Test host process crashed : No usable version of libssl was found
```
It looks like .NET 5 requires OpenSSL 1.0 or 1.1, but some Linux distros only come with 3.1.
https://discussions.unity.com/t/workaround-for-libssl-issue-on-ubuntu-22-04/879165/3
Apache has their own build agents, so it could be something INFRA could address or we could try to add it to the build.
It is not likely related to this PR, though. This is likely something to do with the fact we target ubuntu-latest, although I cannot find any info on when they last updated to a newer version. Just that it is now 24.04.
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2403980884
:warning: **IMPORTANT:** This PR may contain changes to dependency versions. The GitHub Actions test runner is not set up to detect dependency version conflicts between projects. To ensure the changes do not cause dependency conflicts, [run the tests for these changes in Azure DevOps](https://github.com/apache/lucenenet#azure-devops) before accepting this pull request. :warning:
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2403897518
:warning: **IMPORTANT:** This PR may contain changes to dependency versions. The GitHub Actions test runner is not set up to detect dependency version conflicts between projects. To ensure the changes do not cause dependency conflicts, [run the tests for these changes in Azure DevOps](https://github.com/apache/lucenenet#azure-devops) before accepting this pull request. :warning:
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "NightOwl888 (via GitHub)" <gi...@apache.org>.
NightOwl888 commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2405416576
> Yeah, it's more than just the RandomExtensions though. TestFramework has types in the Analysis, Codecs, and Search namespaces that conflict with the links on the homepage. Basically, a `xref:Lucene.Net.Search` is finding the test-framework version first always, for some reason. We would have to change all of those types to not conflict, or dig into the docfx source and figure out what the problem is, possibly having to submit a PR to docfx to fix it unless we're doing something wrong as of the latest versions. It seemed to me that just specifying a URL by hand was an easier fix for now.
Namespaces are meant to be extended by other assemblies. But for some reason, the default setup of docfx doesn't understand that very well. They apparently made some changes to the way metadata is handled that are not compatible with our config that worked on the old version. But it was never great - in the old version links between subsites wouldn't resolve, so I had to hard code them. Now it seems that links are going to the wrong subsite so they have to be hard coded or painstakingly researched.
As sad as it is, hard coding is a solution until we have time to get into the issues with why it fails to resolve many links most of the time. At least now it is spitting out warnings about all of the hard coded URLs so we can easily see what to fix later, so I guess that is an improvement.
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2366957685
:warning: **IMPORTANT:** This PR may contain changes to dependency versions. The GitHub Actions test runner is not set up to detect dependency version conflicts between projects. To ensure the changes do not cause dependency conflicts, [run the tests for these changes in Azure DevOps](https://github.com/apache/lucenenet#azure-devops) before accepting this pull request. :warning:
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "NightOwl888 (via GitHub)" <gi...@apache.org>.
NightOwl888 commented on code in PR #961:
URL: https://github.com/apache/lucenenet/pull/961#discussion_r1772456674
##########
src/dotnet/tools/lucene-cli/docs/index.md:
##########
@@ -11,7 +11,7 @@ The Lucene.NET command line interface (CLI) is a new cross-platform toolchain wi
Perform a one-time install of the lucene-cli tool using the following dotnet CLI command:
```console
-dotnet tool install lucene-cli -g --version 4.8.0-beta00016
+dotnet tool install lucene-cli -g --version EnvVar:LuceneNetVersion
Review Comment:
This is a good suggestion, but while it works *right now*, it does not really address all of the future concerns of having multiple release versions in the wild. Is it convenient to install the latest version with `--prerelease`? Yes. Is that what users should do most of the time? Probably not. They will get into trouble if they try to use a version of the tool that doesn't match the version of Lucene.NET in their project.
This is where we need to be vigilant because in Java you can simply run the commands on the same package that you reference in the project, so the version will always match. But in our case, we need to ensure to lead the users into installing the *matching* version, not the *latest* version. It would be very bad if someone runs the [lucene index fix](https://github.com/apache/lucenenet/blob/cb9545fcde401dea9fdafabf3d99a3fb539f25e9/src/dotnet/tools/lucene-cli/docs/index/fix.md) command using a version that doesn't match what their project is using and they don't have a backup. Although I think there are checks for most of these commands to prevent them from running on non-matching versions, that doesn't cover any potential binary changes that we made to the codecs to address bugs while in prerelease.
After giving it more consideration, I think we should make the following improvements:
1. Change the text from "Perform a one-time install of the lucene-cli tool using the following dotnet CLI command:" to "Perform a one-time install of the lucene-cli tool using the [dotnet tool install](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-tool-install) command, which will install the specified version:"
2. Change the note below the command to read "The version of the CLI you install must match the version of Lucene.NET you use. The version can be specified using the [`--version` option](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-tool-install#options) of the [dotnet tool install](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-tool-install) command. For a list of available versions, see the [versions tab of the lucene-cli NuGet package](https://www.nuget.org/packages/lucene-cli/4.8.0-beta00016#versions-body-tab) or run the [dotnet tool list](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-tool-list) command using the package id `lucene-cli`."
Maybe we should even go further and show examples of how to run the dotnet tool list command inside of that note.
As for whether to keep the `--prerelease` option in the documentation (at least until we are out of prerelease) or specify the `--version`, I think the `--version` is the more conservative approach that will help to prevent users from getting it wrong.
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on code in PR #961:
URL: https://github.com/apache/lucenenet/pull/961#discussion_r1770624811
##########
websites/apidocs/docfx.json:
##########
@@ -16,7 +16,7 @@
],
"dest": "obj/docfx/api/Lucene.Net",
"properties": {
- "TargetFramework": "netstandard2.0"
+ "TargetFramework": "net6.0"
Review Comment:
Broken out as #962
##########
src/dotnet/tools/lucene-cli/docs/index.md:
##########
@@ -44,3 +44,18 @@ CLI command structure consists of the driver ("lucene"), the command, and possib
lucene index check C:\my-index --verbose
lucene index fix C:\my-index
```
+
Review Comment:
Broken out as #962
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2403824135
Items 1 and 2 from the list should be complete. 2 was resolved by changing it to be a local tool instead of global, and we just call `dotnet tool restore` each time. If the version is different, it will pull the desired version locally. This also means it doesn't matter which version is installed on your machine.
Looking at the others.
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on code in PR #961:
URL: https://github.com/apache/lucenenet/pull/961#discussion_r1770623856
##########
websites/site/site.ps1:
##########
@@ -43,21 +45,27 @@ if ($Clean) {
Remove-Item (Join-Path -Path $ToolsFolder "\*") -recurse -force -ErrorAction SilentlyContinue
}
-New-Item "$ToolsFolder\tmp" -type directory -force
+# install docfx tool
+$InstallDocFx = $false
+try {
+ $InstalledDocFxVersion = (& docfx --version).Trim().Split('+')[0]
-# Go get docfx.exe if we don't have it
-New-Item "$ToolsFolder\docfx" -type directory -force
-$DocFxExe = "$ToolsFolder\docfx\docfx.exe"
-if (-not (test-path $DocFxExe))
-{
- Write-Host "Retrieving docfx..."
- $DocFxZip = "$ToolsFolder\tmp\docfx.zip"
- Invoke-WebRequest "https://github.com/dotnet/docfx/releases/download/v2.58/docfx.zip" -OutFile $DocFxZip -TimeoutSec 60
- #unzip
- Expand-Archive $DocFxZip -DestinationPath (Join-Path -Path $ToolsFolder -ChildPath "docfx")
+ if ([version]$InstalledDocFxVersion -lt [version]$DocFxVersion) {
+ Write-Host "DocFx is installed, but the version is less than $DocFxVersion, will install it."
+ $InstallDocFx = $true
+ }
+ else {
+ Write-Host "DocFx is installed and the version is $InstalledDocFxVersion."
+ }
+} catch {
+ Write-Host "DocFx is not installed or not in the PATH, will install it."
+ $InstallDocFx = $true
}
- Remove-Item -Recurse -Force "$ToolsFolder\tmp"
+if ($InstallDocFx -eq $true) {
+ Write-Host "Installing docfx global tool..."
+ dotnet tool install -g docfx --version $DocFxVersion
Review Comment:
I have used `dotnet tool install -g` in various CI builds on GitHub and Azure DevOps and never had an issue. It is installed "globally" for the user, not requiring admin permissions or anything like that.
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2366937895
:warning: **IMPORTANT:** This PR may contain changes to dependency versions. The GitHub Actions test runner is not set up to detect dependency version conflicts between projects. To ensure the changes do not cause dependency conflicts, [run the tests for these changes in Azure DevOps](https://github.com/apache/lucenenet#azure-devops) before accepting this pull request. :warning:
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2366941533
:warning: **IMPORTANT:** This PR may contain changes to dependency versions. The GitHub Actions test runner is not set up to detect dependency version conflicts between projects. To ensure the changes do not cause dependency conflicts, [run the tests for these changes in Azure DevOps](https://github.com/apache/lucenenet#azure-devops) before accepting this pull request. :warning:
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "NightOwl888 (via GitHub)" <gi...@apache.org>.
NightOwl888 commented on code in PR #961:
URL: https://github.com/apache/lucenenet/pull/961#discussion_r1770608515
##########
src/docs/LuceneDocsPlugins/LuceneDocsPlugins.csproj:
##########
@@ -39,32 +39,29 @@ under the License.
<PropertyGroup Label="Assembly Publishing">
<IsPublishable>true</IsPublishable>
</PropertyGroup>
-
+
<PropertyGroup Label="Assembly Signing">
<!-- Ensure this doesn't inherit the strong naming since this tool will no work with a signed assembly due to it's references -->
<SignAssembly>false</SignAssembly>
</PropertyGroup>
-
- <ItemGroup>
- <Compile Remove="packages\**" />
- <EmbeddedResource Remove="packages\**" />
- <None Remove="packages\**" />
- </ItemGroup>
<ItemGroup>
- <None Include="app.config" />
+ <PackageReference Include="Docfx.Plugins" Version="2.76.0" />
+ <PackageReference Include="Docfx.Common" Version="2.76.0" />
+ <PackageReference Include="System.Composition" Version="8.0.0" />
</ItemGroup>
<ItemGroup>
- <PackageReference Include="Microsoft.Composition" Version="1.0.31" />
- <PackageReference Include="Microsoft.DocAsCode.Dfm" Version="2.58.0" />
- <PackageReference Include="YamlDotNet" Version="6.0.0" />
- </ItemGroup>
-
- <ItemGroup>
- <Reference Include="Microsoft.CSharp" />
- <Reference Include="System" />
- <Reference Include="System.Web" />
+ <Compile Remove="EnvironmentVariableInlineRule.cs" />
Review Comment:
Looks like these files were deleted? If so, we don't need these references.
##########
websites/apidocs/docs.ps1:
##########
@@ -34,7 +34,8 @@ param (
[Parameter(Mandatory = $false)]
[int] $StagingPort = 8080
)
-$MinimumSdkVersion = "3.1.100" # Minimum Required .NET SDK (must not be a pre-release)
+$MinimumSdkVersion = "8.0.204" # Minimum Required .NET SDK (must not be a pre-release)
Review Comment:
We definitely don't want the minimum to be the latest version. There is no reason why a machine with 8.0.100 installed shouldn't be able to run this. This should technically be kept in sync with the version in the `runbuild.ps1` file.
##########
src/dotnet/tools/lucene-cli/docs/index.md:
##########
@@ -44,3 +44,18 @@ CLI command structure consists of the driver ("lucene"), the command, and possib
lucene index check C:\my-index --verbose
lucene index fix C:\my-index
```
+
Review Comment:
The Powershell script kept adding these lines at the bottom when it was run, but I usually just revert them before committing. Not sure if the plugin is adding them also, but ideally we wouldn't change anything but the version number.
There are a few other files with these extra lines, also.
##########
websites/site/site.ps1:
##########
@@ -43,21 +45,27 @@ if ($Clean) {
Remove-Item (Join-Path -Path $ToolsFolder "\*") -recurse -force -ErrorAction SilentlyContinue
}
-New-Item "$ToolsFolder\tmp" -type directory -force
+# install docfx tool
+$InstallDocFx = $false
+try {
+ $InstalledDocFxVersion = (& docfx --version).Trim().Split('+')[0]
-# Go get docfx.exe if we don't have it
-New-Item "$ToolsFolder\docfx" -type directory -force
-$DocFxExe = "$ToolsFolder\docfx\docfx.exe"
-if (-not (test-path $DocFxExe))
-{
- Write-Host "Retrieving docfx..."
- $DocFxZip = "$ToolsFolder\tmp\docfx.zip"
- Invoke-WebRequest "https://github.com/dotnet/docfx/releases/download/v2.58/docfx.zip" -OutFile $DocFxZip -TimeoutSec 60
- #unzip
- Expand-Archive $DocFxZip -DestinationPath (Join-Path -Path $ToolsFolder -ChildPath "docfx")
+ if ([version]$InstalledDocFxVersion -lt [version]$DocFxVersion) {
+ Write-Host "DocFx is installed, but the version is less than $DocFxVersion, will install it."
+ $InstallDocFx = $true
+ }
+ else {
+ Write-Host "DocFx is installed and the version is $InstalledDocFxVersion."
+ }
+} catch {
+ Write-Host "DocFx is not installed or not in the PATH, will install it."
+ $InstallDocFx = $true
}
- Remove-Item -Recurse -Force "$ToolsFolder\tmp"
+if ($InstallDocFx -eq $true) {
+ Write-Host "Installing docfx global tool..."
+ dotnet tool install -g docfx --version $DocFxVersion
Review Comment:
This should work when developers are working on the site. But, I have never tried installing as a global tool in CI so I am not sure what the implications are. Could lack of permissions be a problem?
That said, it seems like detecting the environment is either GitHub Actions or Azure DevOps and always doing a local install (with a specific version) would probably be a more robust approach in CI.
##########
src/Lucene.Net.Highlighter/Highlight/WeightedSpanTermExtractor.cs:
##########
@@ -58,7 +58,7 @@ public WeightedSpanTermExtractor(string defaultField)
}
/// <summary>
- /// Fills a <see cref="T:IDictionary{string, WeightedSpanTerm}"/> with <see cref="WeightedSpanTerm"/>s using the terms from the supplied <paramref name="query"/>.
+ /// Fills a <see cref="T:IDictionary{string,WeightedSpanTerm}"/> with <see cref="WeightedSpanTerm"/>s using the terms from the supplied <paramref name="query"/>.
Review Comment:
I know this is probably quicker, but it seems like our project would be easier to maintain if docfx were somehow setup to parse these even if they have spaces in them. It would be a shame to have to remember to do this every time we add documentation.
##########
src/dotnet/tools/lucene-cli/docs/index.md:
##########
@@ -11,7 +11,7 @@ The Lucene.NET command line interface (CLI) is a new cross-platform toolchain wi
Perform a one-time install of the lucene-cli tool using the following dotnet CLI command:
```console
-dotnet tool install lucene-cli -g --version 4.8.0-beta00016
+dotnet tool install lucene-cli -g --version EnvVar:LuceneNetVersion
Review Comment:
Okay, this is an issue that I discussed with Shannon previously. These docs sit in our repo and GitHub has a designer that formats these. Users ***will*** see these markdown docs when browsing our repo. But having these weird tokens in the docs instead of an actual functional command would be quite frustrating for users (in fact, we had a complaint about it before).
So, can we fix this to detect a real version number and replace it like the Powershell script did?
Another lesser issue is figuring out how to automate getting these version numbers incremented in our markdown pages when we do a release. Or at least documenting where they are and adding the steps to the [release procedure](https://lucenenet.apache.org/contributing/make-release.html) to manually update them. We would need to create a release branching scheme (on my todo list) to ensure that the docs in the master branch aren't actually updated until the release is completed.
##########
websites/apidocs/docfx.json:
##########
@@ -16,7 +16,7 @@
],
"dest": "obj/docfx/api/Lucene.Net",
"properties": {
- "TargetFramework": "netstandard2.0"
+ "TargetFramework": "net6.0"
Review Comment:
Is there a way to read these target frameworks from a common location? It will be a lot of maintenance to change these every time a new target is added. It's not critical to fix for this PR, but something to think about.
##########
websites/site/site.ps1:
##########
@@ -43,21 +45,27 @@ if ($Clean) {
Remove-Item (Join-Path -Path $ToolsFolder "\*") -recurse -force -ErrorAction SilentlyContinue
}
-New-Item "$ToolsFolder\tmp" -type directory -force
+# install docfx tool
+$InstallDocFx = $false
+try {
+ $InstalledDocFxVersion = (& docfx --version).Trim().Split('+')[0]
-# Go get docfx.exe if we don't have it
-New-Item "$ToolsFolder\docfx" -type directory -force
-$DocFxExe = "$ToolsFolder\docfx\docfx.exe"
-if (-not (test-path $DocFxExe))
-{
- Write-Host "Retrieving docfx..."
- $DocFxZip = "$ToolsFolder\tmp\docfx.zip"
- Invoke-WebRequest "https://github.com/dotnet/docfx/releases/download/v2.58/docfx.zip" -OutFile $DocFxZip -TimeoutSec 60
- #unzip
- Expand-Archive $DocFxZip -DestinationPath (Join-Path -Path $ToolsFolder -ChildPath "docfx")
+ if ([version]$InstalledDocFxVersion -lt [version]$DocFxVersion) {
Review Comment:
Seems like we should pin to a specific DocFx version so we are guaranteed repeatable runs and avoid different results on different machines, etc.
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on code in PR #961:
URL: https://github.com/apache/lucenenet/pull/961#discussion_r1770623789
##########
websites/site/site.ps1:
##########
@@ -43,21 +45,27 @@ if ($Clean) {
Remove-Item (Join-Path -Path $ToolsFolder "\*") -recurse -force -ErrorAction SilentlyContinue
}
-New-Item "$ToolsFolder\tmp" -type directory -force
+# install docfx tool
+$InstallDocFx = $false
+try {
+ $InstalledDocFxVersion = (& docfx --version).Trim().Split('+')[0]
-# Go get docfx.exe if we don't have it
-New-Item "$ToolsFolder\docfx" -type directory -force
-$DocFxExe = "$ToolsFolder\docfx\docfx.exe"
-if (-not (test-path $DocFxExe))
-{
- Write-Host "Retrieving docfx..."
- $DocFxZip = "$ToolsFolder\tmp\docfx.zip"
- Invoke-WebRequest "https://github.com/dotnet/docfx/releases/download/v2.58/docfx.zip" -OutFile $DocFxZip -TimeoutSec 60
- #unzip
- Expand-Archive $DocFxZip -DestinationPath (Join-Path -Path $ToolsFolder -ChildPath "docfx")
+ if ([version]$InstalledDocFxVersion -lt [version]$DocFxVersion) {
Review Comment:
Yep it is pinned to 2.77 but easy to bump in the future as needed. It's a variable above in the script called `$DocFxVersion`
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on code in PR #961:
URL: https://github.com/apache/lucenenet/pull/961#discussion_r1770631562
##########
src/dotnet/tools/lucene-cli/docs/index.md:
##########
@@ -11,7 +11,7 @@ The Lucene.NET command line interface (CLI) is a new cross-platform toolchain wi
Perform a one-time install of the lucene-cli tool using the following dotnet CLI command:
```console
-dotnet tool install lucene-cli -g --version 4.8.0-beta00016
+dotnet tool install lucene-cli -g --version EnvVar:LuceneNetVersion
Review Comment:
What about replacing this with `dotnet tool install lucene-cli -g --prerelease`? I confirmed that this works, and currently installs beta 16. This way we don't have to keep the version in these docs. We can remove the `--prerelease` once 4.8.0 final is published.
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Docfx Documentation Fixes, Upgrade docfx, Cross-platform support [lucenenet]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #961:
URL: https://github.com/apache/lucenenet/pull/961#issuecomment-2408639803
:warning: **IMPORTANT:** This PR may contain changes to dependency versions. The GitHub Actions test runner is not set up to detect dependency version conflicts between projects. To ensure the changes do not cause dependency conflicts, [run the tests for these changes in Azure DevOps](https://github.com/apache/lucenenet#azure-devops) before accepting this pull request. :warning:
--
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.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org