Skip to content

Latest commit

 

History

History
122 lines (90 loc) · 6.63 KB

github-flow-getting-started.md

File metadata and controls

122 lines (90 loc) · 6.63 KB

Prerequisites

How do I setup the Github app?

  • Register a Github app, with the options listed below:

    • Give your App a name and add a description
    • Homepage URL: Can be anything (Example: repository URL)
    • Add a dummy value for the webhook url, we'll come back to this setting
    • Enter a webhook secret, which you'll need later on when filling in the WebhookSecret property in the appsettings.json file
    • Setup the following permissions
      • Repository
        • Contents - read and write
        • Issues - read and write
        • Metadata - read only
        • Pull requests - read and write
    • Subscribe to the following events:
      • Issues
      • Issue comment
    • Allow this app to be installed by any user or organization

  • After the app is created, generate a private key, we'll use it later for authentication to Github from the app

Which labels should I create?

In order for us to know which skill and persona we need to talk with, we are using Labels in Github Issues.

The default bunch of skills and personnas are as follow:

  • PM.Readme
  • Do.It
  • DevLead.Plan
  • Developer.Implement

Add them to your repository (They are not there by default).

Once you start adding your own skills, just remember to add the corresponding label to your repository.

How do I run this locally?

Codespaces are preset for this repo. For codespaces there is a 'free' tier for individual accounts. See: https://github.com/pricing Start by creating a codespace: https://docs.github.com/en/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository

Alt text

In this sample's folder there are two files called appsettings.azure.template.json and appsettings.local.template.json. If you run this demo locally, use the local template and if you want to run it within Azure use the Azure template. Rename the selected file to appsettings.json and fill out the config values within the file.

GitHubOptions

For the GitHubOptions section, you'll need to fill in the following values:

  • AppKey (PrivateKey): this is a key generated while creating a GitHub App. If you haven't saved it during creation, you'll need to generate a new one. Go to the settings of your GitHub app, scroll down to "Private keys" and click on "Generate a new private key". It will download a .pem file that contains your App Key. Then copy and paste all the -----BEGIN RSA PRIVATE KEY---- your key -----END RSA PRIVATE KEY----- content here, in one line.
  • AppId: This can be found on the same page where you created your app. Go to the settings of your GitHub app and you can see the App ID at the top of the page.
  • InstallationId: Access to your GitHub app installation and take note of the number (long type) at the end of the URL (which should be in the following format: https://github.com/settings/installations/installation-id).
  • WebhookSecret: This is a value that you set when you create your app. In the app settings, go to the "Webhooks" section. Here you can find the "Secret" field where you can set your Webhook Secret.

AzureOptions

The following fields are required and need to be filled in:

  • SubscriptionId: The id of the subscription you want to work on.
  • Location
  • ContainerInstancesResourceGroup: The name of the resource group where container instances will be deployed.
  • FilesAccountName: Azure Storage Account name.
  • FilesShareName: The name of the File Share.
  • FilesAccountKey: The File Account key.
  • SandboxImage

In the Explorer tab in VS Code, find the Solution explorer, right click on the gh-flow project and click Debug -> Start new instance

Alt text

We'll need to expose the running application to the GH App webhooks, for example using DevTunnels, but any tool like ngrok can also work. The following commands will create a persistent tunnel, so we need to only do this once:

TUNNEL_NAME=_name_your_tunnel_here_
devtunnel user login
devtunnel create -a $TUNNEL_NAME
devtunnel port create -p 5244 $TUNNEL_NAME

and once we have the tunnel created we can just start forwarding with the following command:

devtunnel host $TUNNEL_NAME

Copy the local address (it will look something like https://your_tunnel_name.euw.devtunnels.ms) and append /api/github/webhooks at the end. Using this value, update the Github App's webhook URL and you are ready to go!

Before you go and have the best of times, there is one last thing left to do load the WAF into the vector DB

Also, since this project is relying on Orleans for the Agents implementation, there is a dashboard available at https://yout_tunnel_name.euw.devtunnels.ms/dashboard, with useful metrics and stats related to the running Agents.

How do I deploy the azure bits?

This sample is setup to use azd to work with the Azure bits. azd is installed in the codespace.

Let's start by logging in to Azure using

azd auth login

After we've logged in, we need to create a new environment provision the azure bits.

ENVIRONMENT=_name_of_your_env
azd env new $ENVIRONMENT
azd provision -e $ENVIRONMENT

After the provisioning is done, you can inspect the outputs with the following command

azd env get-values -e dev

As the last step, we also need to load the WAF into the vector DB

Load the WAF into Qdrant.

If you are running the app locally, we have Qdrant setup in the Codespace and if you are running in Azure, Qdrant is deployed to ACA. The loader is a project in the samples folder, called seed-memory. We need to fill in the appsettings.json (after renaming appsettings.template.json in appsettings.json) file in the config folder with the OpenAI details and the Qdrant endpoint, then just run the loader with dotnet run and you are ready to go.