Skip to content

Commit 30fc2b6

Browse files
Add FAQS (#290)
* Add FAQS * Update docs/FAQS.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/FAQS.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 75794b4 commit 30fc2b6

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

docs/FAQS.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Frequently Asked Questions
2+
3+
### How do I get access to nightly builds?
4+
5+
Nightly builds of the Agent Framework are available [here](https://github.com/orgs/microsoft/packages?repo_name=agent-framework).
6+
7+
To download nightly builds follow the following steps:
8+
9+
1. You will need a GitHub account to complete these steps.
10+
1. Create a GitHub Personal Access Token with the `read:packages` scope using these [instructions](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic).
11+
1. If your account is part of the Microsoft organization then you must authorize the `Microsoft` organization as a single sign-on organization.
12+
1. Click the "Configure SSO" next to the Personal Access Token you just created and then authorize `Microsoft`.
13+
1. Use the following command to add the Microsoft GitHub Packages source to your NuGet configuration:
14+
15+
```powershell
16+
dotnet nuget add source --username GITHUBUSERNAME --password GITHUBPERSONALACCESSTOKEN --store-password-in-clear-text --name GitHubMicrosoft "https://nuget.pkg.github.com/microsoft/index.json"
17+
```
18+
19+
1. Or you can manually create a `NuGet.Config` file.
20+
21+
```xml
22+
<?xml version="1.0" encoding="utf-8"?>
23+
<configuration>
24+
<packageSources>
25+
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
26+
<add key="github" value="https://nuget.pkg.github.com/microsoft/index.json" />
27+
</packageSources>
28+
29+
<packageSourceMapping>
30+
<packageSource key="nuget.org">
31+
<package pattern="*" />
32+
</packageSource>
33+
<packageSource key="github">
34+
<package pattern="*nightly"/>
35+
</packageSource>
36+
</packageSourceMapping>
37+
38+
<packageSourceCredentials>
39+
<github>
40+
<add key="Username" value="<Your GitHub Id>" />
41+
<add key="ClearTextPassword" value="<Your Personal Access Token>" />
42+
</github>
43+
</packageSourceCredentials>
44+
</configuration>
45+
```
46+
47+
* If you place this file in your project folder make sure to have Git (or whatever source control you use) ignore it.
48+
* For more information on where to store this file go [here](https://learn.microsoft.com/en-us/nuget/reference/nuget-config-file).
49+
1. You can now add packages from the nightly build to your project.
50+
* E.g. use this command `dotnet add package Microsoft.Extensions.AI.Agents --version 0.0.1-nightly-250731.6-alpha`
51+
1. And the latest package release can be referenced in the project like this:
52+
* `<PackageReference Include="Microsoft.Extensions.AI.Agents" Version="*-*" />`
53+
54+
For more information see: <https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry>

0 commit comments

Comments
 (0)