Update docs (#11)

* docs update WIP

* getting started guide updated

* update getting started guide

* clarify github app creation

* add webhook secret to getting started guide and gh-flow app

* restructure Readme

* fix the Organization assumption

* add mermaid diagram of the event flow

* devtunnel feature to devcontainer

* throw all the exceptions and add the history to the prompt

* Update github-flow.md

* update readme
This commit is contained in:
Kosta Petan
2024-03-14 16:29:23 +01:00
committed by GitHub
parent 36951aa216
commit baabd413eb
23 changed files with 281 additions and 416 deletions

View File

@@ -1,78 +1,34 @@
![](/docs/images/github-sk-dev-team.png)
# How does the event flow look like?
```mermaid
graph TD;
NEA([NewAsk event]) -->|Hubber| NEA1[Creation of PM issue, DevLead issue, and new branch];
RR([ReadmeRequested event]) -->|ProductManager| PM1[Generation of new README];
NEA1 --> RR;
PM1 --> RG([ReadmeGenerated event]);
RG -->|Hubber| RC[Post the readme as a new comment on the issue];
RC --> RCC([ReadmeChainClosed event]);
RCC -->|ProductManager| RCR([ReadmeCreated event]);
RCR --> |AzureGenie| RES[Store Readme in blob storage];
RES --> RES2([ReadmeStored event]);
RES2 --> |Hubber| REC[Readme commited to branch and create new PR];
DPR([DevPlanRequested event]) -->|DeveloperLead| DPG[Generation of new development plan];
NEA1 --> DPR;
DPG --> DPGE([DevPlanGenerated event]);
DPGE -->|Hubber| DPGEC[Posting the plan as a new comment on the issue];
DPGEC --> DPCC([DevPlanChainClosed event]);
DPCC -->|DeveloperLead| DPCE([DevPlanCreated event]);
DPCE --> |Hubber| DPC[Creates a Dev issue for each subtask];
### Hubber agent handles:
```
NewAsk
-> create PM issue
-> create DevLead issue
-> create a branch
DPC([CodeGenerationRequested event]) -->|Developer| CG[Generation of new code];
CG --> CGE([CodeGenerated event]);
CGE -->|Hubber| CGC[Posting the code as a new comment on the issue];
CGC --> CCCE([CodeChainClosed event]);
CCCE -->|Developer| CCE([CodeCreated event]);
CCE --> |AzureGenie| CS[Store code in blob storage and schedule a run in the sandbox];
CS --> SRC([SandboxRunCreated event]);
SRC --> |Sandbox| SRM[Check every minute if the run finished];
SRM --> SRF([SandboxRunFinished event]);
SRF --> |Hubber| SRCC[Code files commited to branch];
```
```
ReadmeGenerated
-> post comment
```
```
DevPlanGenerated
-> post comment
```
```
DevPlanFinished
-> for each step, create Dev issue
```
```
CodeGenerated
-> post comment
```
```
ReadmeFinished
-> commit to branch
```
```
SandboxRunFinished
-> commit to branch
```
### AzureOps agent handles:
```
ReadmeChainClosed
-> store
-> ReadmeStored
```
```
CodeChainClosed
-> store
-> run in sandbox
```
### PM agent handles:
```
ReadmeRequested
-> ReadmeGenerated
```
```
ChainClosed
-> ReadmeFinished
```
### DevLead agent handles:
```
DevPlanRequested
-> DevPlanGenerated
```
```
ChainClosed
-> DevPlanFinished
```
### Dev handles:
```
CodeGenerationRequested
-> CodeGenerated
```
```
ChainClosed
-> CodeFinished
```