TirSystem/github-action

Fork 0

Files

T

Tirsvad a04b578d70

TirSystem/github-action: Publish wiki / publish-wiki (push) Skipped

TirSystem/github-action: Sync GitHub mirror metadata / sync-metadata (push) Skipped

Validate workflows / validate (pull_request) Successful in 15s

Details

Resolve pending commit links in the release process documents

2026-10-10 22:46:26 +08:00

4.4 KiB

Raw Blame History

Use Case Diagram

Metadata

Key	Value
ID	UCD-001
CrossReference	SA-001, BC-001, US-001, UC-001, UC-002, UC-003, UC-004, UC-005, UC-006

Version History

Date	Status	Author	Reviewer	Change	Commit
2026-10-10	Deprecated	Jens Tirsvad Nielsen	S01	Added the actor Software Engineer and the use case Run Project Quality Checks	385d2fb
2026-10-10	Accepted	Jens Tirsvad Nielsen	S01	Added the use case Release a Reusable Workflow (UC-006)	044d8ba

Purpose and Scope

The boundary is the reusable workflow collection of this repository: the Gitea Actions workflows, their credential checks and the guides that go with them. Inside it are the four P1 goals of the Project Plan: keeping the GitHub mirror's description and topics equal to Gitea's, configuring the credentials a workflow needs, bringing a repository onto the shared workflows, and finding the cause of a failed run. Gitea and GitHub are outside the boundary and are shown as external systems. Running quality checks is the first software engineer goal (P2). Releases and the other P2 and P3 use cases are not drawn yet.

Diagram

@startuml
left to right direction
skinparam packageStyle rectangle

actor "DevOps Professional" as DevOps <<Actor>>
actor "Platform Operator" as Operator <<Actor>>
actor "Software Engineer" as Engineer <<Actor>>
actor "Gitea Instance" as Gitea <<System>>
actor "GitHub" as GitHub <<System>>

rectangle "Reusable Workflow Collection" <<System>> {
  usecase "Synchronize Repository Metadata" as UC1
  usecase "Configure Workflow Credentials" as UC2
  usecase "Onboard a Repository" as UC3
  usecase "Diagnose a Failed Workflow" as UC4
  usecase "Run Project Quality Checks" as UC5
  usecase "Release a Reusable Workflow" as UC6
}

DevOps --> UC1
DevOps --> UC2
DevOps --> UC3
DevOps --> UC4
DevOps --> UC6
Operator --> UC2
Operator --> UC4
Engineer --> UC5
UC1 --> Gitea
UC1 --> GitHub
UC3 ..> UC2 : <<include>>
UC4 ..> UC1 : <<extend>>
@enduml

Actor Table

Actor	Stereotype	Stakeholder ID (SA)	Goals (use cases)
DevOps Professional	`<<Actor>>`	S05	Synchronize Repository Metadata, Configure Workflow Credentials, Onboard a Repository, Diagnose a Failed Workflow, Release a Reusable Workflow
Platform Operator	`<<Actor>>`	S03	Configure Workflow Credentials, Diagnose a Failed Workflow
Software Engineer	`<<Actor>>`	S02	Run Project Quality Checks
Gitea Instance	`<<System>>`	-	Synchronize Repository Metadata (source of description and topics)
GitHub	`<<System>>`	S04 (audience of the mirror)	Synchronize Repository Metadata (target)

Use Case Table

Use Case	Actor(s)	Goal
Synchronize Repository Metadata	DevOps Professional	The GitHub mirror shows the Gitea description and topics
Configure Workflow Credentials	DevOps Professional, Platform Operator	Least-privilege tokens that a workflow accepts
Onboard a Repository	DevOps Professional	A repository consumes the shared workflows
Diagnose a Failed Workflow	DevOps Professional, Platform Operator	The cause of a failed run is found and placed in a category
Run Project Quality Checks	Software Engineer	Lint, format and type checks run on every change and report a pass or a fail
Release a Reusable Workflow	DevOps Professional	A validated, versioned update that consumers can pin

Relationships

Relationship	Justification
Onboard a Repository `<<include>>` Configure Workflow Credentials	Every onboarding needs working credentials; the behaviour is always part of it and is also used on its own when a token is rotated.
Diagnose a Failed Workflow `<<extend>>` Synchronize Repository Metadata	The extension applies only when a run of the synchronization has failed; the synchronization is complete without it.

4.4 KiB Raw Blame History