Date: 2024-07-30
+Accepted
+We need to record the architectural decisions made on this project.
+We will use Architecture Decision Records, as described by Michael Nygard.
+See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's adr-tools.
+ + + + + + + + + + + + + +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 --> GithubActionsgraph 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 --> TrestlebotCLIgraph 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