-
Notifications
You must be signed in to change notification settings - Fork 867
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
Conversation
|
||
3. Follow the instructions and complete the login steps. | ||
|
||
4. Download docfx nuget package from GitHub Packages |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
- [Feature Request] Publish docfx
prerelease
version NuGet packages #9609 (comment) docfx/.github/workflows/nightly.yml
Lines 55 to 76 in 5d68cfe
- 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
There was a problem hiding this comment.
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.
This PR add
How to use prerelease version of docfx
section toQuick Start
page.By following the instructions in this section.
It can install pre-release version of docfx from
GitHub Packages
.