Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set PublishReferencesDocumentationFiles=false in fake-cli #2829

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Numpsy
Copy link
Contributor

@Numpsy Numpsy commented Sep 22, 2024

Description

Just a thought when looking at the build output for fake-cli - Is there a need to have the XML documentation files for a bunch of the FAKE libraries included in the fake-cli NuGet package?

e.g.
image

@Thorium
Copy link
Member

Thorium commented Sep 22, 2024

Maybe they help for API-docs (https://fake.build/reference/index.html) or user tool-tips?

@Numpsy
Copy link
Contributor Author

Numpsy commented Sep 22, 2024

The documentation XML files in the individual library nuget packages can be used for intellisense and such, and the doc comments themselves are used by the published documentation, but I didn't think the files in the dotnet global tool would be loaded as the package isn't attached to consuming projects like a library is (naybe I'm wrong there though)

@Thorium
Copy link
Member

Thorium commented Sep 23, 2024

Many people still use Fake not via cli-tool but as "dotnet fsi build.fsx" with independent library dependencies, and I think xml-docs there will help.

@xperiandri
Copy link
Collaborator

@Numpsy Do you disable XML docs output only for CLI tool?

@Numpsy
Copy link
Contributor Author

Numpsy commented Sep 24, 2024

@Numpsy Do you disable XML docs output only for CLI tool?

That was the intent - e.g. in my local build the Fake.DotNet.Cli NuGet package contains the documentation XML file, but the fake-cli package doesn't -

image

@xperiandri
Copy link
Collaborator

@Numpsy let's merge?

@Numpsy Numpsy marked this pull request as ready for review October 3, 2024 13:07
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Test Results

    9 files  ±0      9 suites  ±0   37m 26s ⏱️ - 9m 41s
  439 tests ±0    439 ✅ ±0  0 💤 ±0  0 ❌ ±0 
1 251 runs  ±0  1 251 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 429cf51. ± Comparison against base commit 6f2fc43.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants