Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adds create #21

Merged
merged 3 commits into from
Jul 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions docs/diagrams/architecture/c4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
## Context

```mermaid
graph LR
subgraph External
User
end

subgraph Container
ContainerImage("Container Image")
TrestlebotContainer("Trestlebot Container")
end

subgraph GitHub
OSCALRepo("OSCAL Content Repository")
GithubActions("GitHub Actions")
CustomAction("Custom GitHub Action")
end

User -- Uses --> OSCALRepo
GithubActions -- Triggers --> CustomAction
CustomAction -- Builds --> ContainerImage
ContainerImage -- Runs --> TrestlebotContainer
OSCALRepo -- Uses --> GithubActions
User -- Uses --> GithubActions
```

## Container

```mermaid
graph LR
subgraph Container
ContainerImage("Container Image")
TrestlebotCLI("Trestlebot CLI")
end
subgraph GitHub
GithubActions("GitHub Actions")
CustomAction("Custom GitHub Action")
end


GithubActions -- Triggers --> CustomAction
CustomAction -- Builds --> ContainerImage
ContainerImage -- Distributes --> TrestlebotCLI
```

## Component

```mermaid
graph TD
subgraph Container
TrestlebotCLI("Trestlebot CLI")
Entrypoint("Entrypoint script")
end

subgraph Runtime
EnvironmentVariables("Environment Variables")
GitRepo("Git Local Repository")
end

subgraph GitHub
GitHubAction("GitHub Action")
GitHubAPI("GitHub API")
end

GitHubAction -- Sets --> EnvironmentVariables
GitHubAction -- Uses --> Entrypoint
TrestlebotCLI -- Reads content --> GitRepo
Entrypoint -- Runs --> TrestlebotCLI
Entrypoint -- Reads --> EnvironmentVariables
TrestlebotCLI -- Update content --> GitHubAPI
```
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Assemble Diagrams
# Diagrams: Assemble

## Context

Expand All @@ -18,8 +18,4 @@ graph LR
Trestle_Bot --> Compliance_Trestle["Compliance-Trestle SDK"]
Compliance_Trestle --> Git_Provider_API["Git Provider API"]
Git_Provider_API --> Branch["User's Git Branch"]
```

## Component

## Code
```
24 changes: 24 additions & 0 deletions docs/diagrams/workflows/create_diagrams.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Diagrams: Create Content

## Context

```mermaid
graph LR
User["User"] --> Workflow_Dispatch["Workflow Dispatch"]
Workflow_Dispatch --> Trestle_Bot["Trestle-Bot"]
Trestle_Bot --> New_Branch["New Branch"]
New_Branch --> PR["Draft Pull Request"]

```

## Container

```mermaid
graph LR
User["User"] --> GH_Action["GitHub Action"]
GH_Action --> Trestle_Bot["Trestle-Bot"]
Trestle_Bot --> Compliance_Trestle["Compliance-Trestle SDK"]
Compliance_Trestle --> Git_Provider_API["Git Provider API"]
Git_Provider_API --> Branch["New Branch"]
Branch --> PR["Draft Pull Request"]
```