You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tools/README.md
+33-1Lines changed: 33 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,39 @@ Typically a SDK is generated by:
12
12
3. Generating SDK source code
13
13
4. Validation and linting for generation process
14
14
15
-
## Using Tools
15
+
## Tools folder structure
16
+
17
+
-`config` - OpenAPI generator config
18
+
-`releaser` - release automation scripts and documentation
19
+
-`transformer` - OpenAPI transformation engine and it's documentation
20
+
21
+
## SDK Generation Workflow
22
+
23
+
```mermaid
24
+
flowchart TD
25
+
0[Atlas API Release] --> |Perdiodical Check|A[New Atlas OpenAPI file]
26
+
A[New Atlas OpenAPI file] -->|Generate Code and Docs| B[Generator Automation]
27
+
B -->|Create| GithubPR[Github APIBot PR]
28
+
GithubPR -->|Manual Review| D[APIBot PR Approval and Merge]
29
+
D -->|Trigger| C[SDK Release Automation]
30
+
C -->|Release SDK| End[Release Tag]
31
+
```
32
+
33
+
1.**Fetch File**: We Periodically Fetch for the Changes in the Public OpenAPI file
34
+
35
+
2.**Generate Code and Docs**: The next step involves generating code and documentation based on the contents of the OpenAPI file. This is an automated process done by github actions.
36
+
37
+
3.**Create PR**: After the code and documentation are generated, a pull request (PR) is created on GitHub. The purpose of this PR is to visualize all changes before merging them to the main branch.
38
+
39
+
4.**Manual Review**: The pull request undergoes manual review by by the assigned team. The reviewers check the changes, verify their correctness, and assess their impact based on the PR description.
40
+
41
+
5.**APIBot PR Approval and Merge**: If the manual review is successful, and the changes are approved, the pull request is merged into the main repository.
42
+
43
+
6.**Trigger SDK Release Automation**: The successful merge of the pull request triggers the next step, which is the SDK Release Automation process.
44
+
45
+
7.**Release SDK**: SDK is released by creating Github Release.
0 commit comments