Files
Mark WallaceandRoger Barreto 38dc3cb2a9 FAQ explaining how to access nightly builds (#3061)
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [ ] The code builds clean without any errors or warnings
- [ ] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ ] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄

---------

Co-authored-by: Roger Barreto <[email protected]>
2024-01-12 13:33:47 +00:00

2.8 KiB

Frequently Asked Questions

How do I get access to nightly builds?

Nightly builds of the Semantic Kernel are available here.

To download nightly builds follow the following steps:

  1. You will need a GitHub account to complete these steps.

  2. Create a GitHub Personal Access Token with the read:packages scope using these instructions.

  3. If you account is part of the Microsoft organization then you must authorize the Microsoft organization as a single sign-on organization.

    1. Click the "Configure SSO" next to the Person Access Token you just created and then authorize Microsoft.
  4. Use the following command to add the Microsoft GitHub Packages source to your NuGet configuration:

    dotnet nuget add source --username GITHUBUSERNAME --password GITHUBPERSONALACCESSTOKEN --store-password-in-clear-text --name GitHubMicrosoft "https://nuget.pkg.github.com/microsoft/index.json"
    
  5. Or you can manually create a NuGet.Config file.

    <?xml version="1.0" encoding="utf-8"?>
    <configuration>
      <packageSources>
        <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
        <add key="github" value="https://nuget.pkg.github.com/microsoft/index.json" />
      </packageSources>
    
      <packageSourceMapping>
        <packageSource key="nuget.org">
          <package pattern="*" />
        </packageSource>
        <packageSource key="github">
          <package pattern="*nightly"/>
        </packageSource>
      </packageSourceMapping>
    
      <packageSourceCredentials>
        <github>
            <add key="Username" value="<Your GitHub Id>" />
            <add key="ClearTextPassword" value="<Your Personal Access Token>" />
          </github>
      </packageSourceCredentials>
    </configuration>
    
    • If you place this file in your project folder make sure to have Git (or whatever source control you use) ignore it.
    • For more information on where to store this file go here.
    • You can also use the following command he Microsoft GitHub Packages source can be added easier to NuGet:
  6. You can now add packages from the nightly build to your project.

    • E.g. use this command dotnet add package Microsoft.SemanticKernel.Core --version 0.26.231003.1-nightly
  7. And the latest package release can be referenced in the project like this:

    • <PackageReference Include="Microsoft.SemanticKernel" Version="*-*" />

For more information see: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry