-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[IOSP-515] [CNSMR-3231] Documentation (#52)
* Fix doc comment * Moved WallEView.xcodeproj one level deeper To avoid ambiguity when using `xed .` or `vapor xcode -y` * Fix compilation issue: missing new file from Bot/Models * Update README for WallEView * "How it works" + "Implementation details" sections * Add diagrams * GraphViz: update pack mode for nicer layout * Fix typo in diagram name * Apply suggestions from code review Co-Authored-By: Daniel Spindelbauer <[email protected]> * Add paragraph about configuration via env vars * Apply same rewording feedbacks as in other PR * Apply suggestions from code review Co-Authored-By: Ilya Puchka <[email protected]> Co-authored-by: Daniel Spindelbauer <[email protected]> Co-authored-by: Ilya Puchka <[email protected]>
- Loading branch information
1 parent
767931e
commit 036eb7f
Showing
11 changed files
with
319 additions
and
19 deletions.
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,114 @@ | ||
# https://edotor.net/ | ||
|
||
digraph MergeBot { | ||
pack=true | ||
|
||
subgraph states { | ||
node [shape=oval][style=filled,fillcolor=lightgray] | ||
starting [penwidth=3] | ||
# idle | ||
ready | ||
integrating | ||
runningStatusChecks | ||
integrationFailed | ||
"*" | ||
} | ||
|
||
subgraph events { | ||
node [shape=box][style=dotted] | ||
".pullRequestsLoaded" | ||
".pullRequestDidChange(.include)" | ||
".pullRequestDidChange(.exclude)" | ||
".noMorePullRequests" | ||
".integrationDidChangeStatus(.done)" | ||
".integrationDidChangeStatus(.failed)" | ||
".integrationDidChangeStatus(.updating)" | ||
".integrate" | ||
".statusChecksDidComplete(.passed)" | ||
".statusChecksDidComplete(.failed)" | ||
".statusChecksDidComplete(.timedOut)" | ||
".integrationFailureHandled" | ||
".retryIntegration" | ||
} | ||
|
||
subgraph actions { | ||
node [shape=rect] | ||
dequeuePR | ||
fetchPullRequest1 [label=fetchPullRequest] | ||
fetchPullRequest2 [label=fetchPullRequest] | ||
fetchPullRequest3 [label=fetchPullRequest] | ||
mergePullRequest | ||
updatePR # merge target branch back in PR | ||
fetchCommitStatus | ||
fetchAllStatusChecks | ||
includePR | ||
excludePR | ||
postComment | ||
removeLabel | ||
} | ||
|
||
subgraph feedbacks { | ||
color=blue | ||
|
||
subgraph cluster_whenStarting { | ||
label="whenStarting" | ||
starting -> ".pullRequestsLoaded" | ||
} | ||
|
||
subgraph cluster_whenReady { | ||
label="whenReady" | ||
ready -> dequeuePR | ||
dequeuePR -> ".noMorePullRequests" [label="nil"] | ||
dequeuePR -> fetchPullRequest1 -> ".integrate" | ||
} | ||
|
||
subgraph cluster_whenIntegrating { | ||
label="whenIntegrating" | ||
integrating -> ".integrationDidChangeStatus(.done)" [label="pr.isMerged"] | ||
|
||
# clean | ||
integrating -> mergePullRequest [label="state=clean"] | ||
mergePullRequest -> ".integrationDidChangeStatus(.done)" [label="ok"] | ||
mergePullRequest -> ".integrationDidChangeStatus(.failed)" [label="error"] | ||
|
||
# behind | ||
integrating -> updatePR [label="state=behind"] | ||
updatePR -> ".integrationDidChangeStatus(.updating)" [label="success|upToDate"] | ||
updatePR -> ".integrationDidChangeStatus(.failed)" [label="conflict"] | ||
|
||
# blocked|unstable | ||
integrating -> fetchAllStatusChecks [label="state=blocked|unstable"] | ||
fetchAllStatusChecks -> ".integrationDidChangeStatus(.updating)" [label="pending"] | ||
fetchAllStatusChecks -> ".integrationDidChangeStatus(.failed)" [label="failure"] | ||
fetchAllStatusChecks -> ".retryIntegration" [label="success"] | ||
|
||
# dirty | ||
integrating -> ".integrationDidChangeStatus(.failed)" [label="state=dirty (conflicts)"] | ||
|
||
# unknown | ||
integrating -> fetchPullRequest2 -> ".retryIntegration" [label="state=unknown"] | ||
} | ||
|
||
subgraph cluster_whenRunningStatusChecks { | ||
label="whenRunningStatusChecks" | ||
runningStatusChecks -> fetchPullRequest3 [label="on statusCheckObserver change"] | ||
fetchPullRequest3 -> fetchCommitStatus | ||
fetchCommitStatus -> ".statusChecksDidComplete(.failed)" [label="failure"] | ||
fetchCommitStatus -> ".statusChecksDidComplete(.passed)" [label="success"] | ||
runningStatusChecks -> ".statusChecksDidComplete(.timedOut)" [label="timeout"] | ||
} | ||
|
||
subgraph cluster_whenIntegrationFailed { | ||
label="whenIntegrationFailed" | ||
integrationFailed -> postComment -> removeLabel -> ".integrationFailureHandled" | ||
} | ||
} | ||
|
||
subgraph cluster_reduceDefault { | ||
color=blue | ||
label="reduceDefault()" | ||
"*" -> ".pullRequestDidChange(.include)" -> includePR | ||
"*" -> ".pullRequestDidChange(.exclude)" -> excludePR | ||
} | ||
|
||
} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.