57 lines
2.5 KiB
Markdown
57 lines
2.5 KiB
Markdown
# System Sequence Diagram
|
|
|
|
## Metadata
|
|
| Key | Value |
|
|
| --- | --- |
|
|
| ID | SSD-001 |
|
|
| CrossReference | [UC-001], [DM-001], [OC-001] |
|
|
|
|
## Version History
|
|
| Date | Status | Author | Reviewer | Change | Commit |
|
|
| --- | --- | --- | --- | --- | --- |
|
|
| 2026-10-06 | Accepted | Jens Tirsvad Nielsen | S02 | writeEnvFile parameter and the credentials that .env does not provide | [ded26a6] |
|
|
| 2026-10-06 | Proposed | Jens Tirsvad Nielsen | S02 | The license is not a parameter: it comes from config.env or follows the GitHub choice | [d773fa9] |
|
|
|
|
---
|
|
|
|
## Source Use Case
|
|
|
|
Create a new project ([UC-001]) — scenario: main success scenario
|
|
|
|
## Diagram
|
|
|
|
```plantuml
|
|
@startuml
|
|
actor Maintainer as A
|
|
participant ":System" as S
|
|
A -> S : startProjectCreation()
|
|
S --> A : prompts for project details
|
|
A -> S : provideProjectDetails(name, description, visibility, giteaOwner, githubOwner, directory, enablePlanGate, writeEnvFile)
|
|
S --> A : checks passed
|
|
S --> A : creation summary
|
|
@enduml
|
|
```
|
|
|
|
## System Operations
|
|
|
|
| Step | Message | Parameters | Return | Use case step |
|
|
| --- | --- | --- | --- | --- |
|
|
| 1 | startProjectCreation | none | prompts for project details (after configuration and tool checks; a missing credential is asked first) | 1, 2 |
|
|
| 2 | provideProjectDetails | name, description, visibility, giteaOwner, githubOwner (optional; given means GitHub is chosen; omitted means no GitHub), directory, enablePlanGate (each of these may come from `config.env` instead of the Maintainer; the message is unchanged), writeEnvFile (whether to create the project's `.env`), and the credentials that `.env` does not provide (GitHub ones only when GitHub is chosen) | checks passed, then a creation summary | 3 to 10 |
|
|
|
|
The license that applies is not a parameter: it is read from `config.env` (`PROJECT_LICENSE`) or, when none is set, follows the GitHub choice.
|
|
|
|
Steps 4 to 9 are internal to the system, so one operation covers them. A consent question (step 8a, 9a, 9b) is a prompt from the system and is out of scope for this diagram; failure flows are out of scope here.
|
|
|
|
## Lifecycle Notes
|
|
|
|
The system is one script run. It starts with the first operation and ends after the summary; nothing persists between runs except the `.env` the Maintainer agreed to in the new project.
|
|
|
|
---
|
|
|
|
[UC-001]: ./uc.md
|
|
[DM-001]: ./dm.md
|
|
[OC-001]: ./oc.md
|
|
[ded26a6]: https://git.tirsystem.com/TirSystem-BashScript/repo_foundry/commit/ded26a658c666bf29d84093cb352e3635e07719b
|
|
[d773fa9]: https://git.tirsystem.com/TirSystem-BashScript/repo_foundry/commit/d773fa91df5a54090254e12e074880fb6526a9ff
|