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

docs: Add how to use docfx nightly version #10394

Merged
merged 1 commit into from
Nov 20, 2024

Conversation

filzrev
Copy link
Contributor

@filzrev filzrev commented Nov 17, 2024

This PR add How to use prerelease version of docfx section to Quick Start page.

By following the instructions in this section.
It can install pre-release version of docfx from GitHub Packages.


3. Follow the instructions and complete the login steps.

4. Download docfx nuget package from GitHub Packages
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we recommend adding GitHub feed URL to NuGet.config?

Copy link
Contributor Author

@filzrev filzrev Nov 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we recommend adding GitHub feed URL to NuGet.config?

I don't consider it particularly necessary.
GitHub Packages requires PAT token for using public packages.
So It's simpler downloading nupkg by using gh command and REST APIs.

Examples of using GitHub Packages with NuGet.confg

  1. [Feature Request] Publish docfx prerelease version NuGet packages #9609 (comment)
  2. - name: Create NuGet.config
    shell: pwsh
    run: |
    @'
    <?xml version="1.0" encoding="utf-8"?>
    <configuration>
    <packageSources>
    <clear />
    <add key="github" value="https://nuget.pkg.github.com/dotnet/index.json" />
    </packageSources>
    <packageSourceCredentials>
    <github>
    <add key="Username" value="%USER%" />
    <add key="ClearTextPassword" value="%GITHUB_TOKEN%" />
    </github>
    </packageSourceCredentials>
    </configuration>
    '@ | Out-File NuGet.config -Encoding UTF8
    - name: Install nightly build package
    run: |
    dotnet tool install docfx -g --prerelease

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, people should find how to authenticate against GH packages if they want to use NuGet.config.

@yufeih yufeih added the documentation Improvements or additions to documentation and the project website label Nov 20, 2024
@yufeih yufeih merged commit 56cd19f into dotnet:main Nov 20, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation and the project website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants