From 6c92f64f8bcec3306ef13a22e91939f555a9c77d Mon Sep 17 00:00:00 2001 From: Paul Campbell Date: Sun, 14 Jul 2024 20:58:58 +0100 Subject: [PATCH] docs: add readmes to each crate to direct users to main crate Closes kemitix/git-next#106 --- crates/actor-macros/README.md | 9 +++++++ crates/config/README.md | 9 +++++++ crates/file-watcher-actor/README.md | 9 +++++++ crates/forge-forgejo/README.md | 9 +++++++ crates/forge-github/README.md | 9 +++++++ crates/forge/README.md | 9 +++++++ crates/git/README.md | 9 +++++++ crates/repo-actor/MESSAGES.md | 36 ++++++++++++++++++++++++++ crates/repo-actor/README.md | 39 +++++------------------------ crates/server-actor/MESSAGES.md | 17 +++++++++++++ crates/server-actor/README.md | 20 +++++---------- crates/server/README.md | 9 +++++++ crates/webhook-actor/README.md | 9 +++++++ 13 files changed, 146 insertions(+), 47 deletions(-) create mode 100644 crates/actor-macros/README.md create mode 100644 crates/config/README.md create mode 100644 crates/file-watcher-actor/README.md create mode 100644 crates/forge-forgejo/README.md create mode 100644 crates/forge-github/README.md create mode 100644 crates/forge/README.md create mode 100644 crates/git/README.md create mode 100644 crates/repo-actor/MESSAGES.md create mode 100644 crates/server-actor/MESSAGES.md create mode 100644 crates/server/README.md create mode 100644 crates/webhook-actor/README.md diff --git a/crates/actor-macros/README.md b/crates/actor-macros/README.md new file mode 100644 index 0000000..ddc70e2 --- /dev/null +++ b/crates/actor-macros/README.md @@ -0,0 +1,9 @@ +# git-next + +## Trunk-based developement manager. + +`git-next` is a combined server and command-line tool that enables trunk-based +development workflows where each commit must pass CI before being included in +the main branch. + +See [git-next](https://crates.io/crates/git-next) for more information. diff --git a/crates/config/README.md b/crates/config/README.md new file mode 100644 index 0000000..ddc70e2 --- /dev/null +++ b/crates/config/README.md @@ -0,0 +1,9 @@ +# git-next + +## Trunk-based developement manager. + +`git-next` is a combined server and command-line tool that enables trunk-based +development workflows where each commit must pass CI before being included in +the main branch. + +See [git-next](https://crates.io/crates/git-next) for more information. diff --git a/crates/file-watcher-actor/README.md b/crates/file-watcher-actor/README.md new file mode 100644 index 0000000..ddc70e2 --- /dev/null +++ b/crates/file-watcher-actor/README.md @@ -0,0 +1,9 @@ +# git-next + +## Trunk-based developement manager. + +`git-next` is a combined server and command-line tool that enables trunk-based +development workflows where each commit must pass CI before being included in +the main branch. + +See [git-next](https://crates.io/crates/git-next) for more information. diff --git a/crates/forge-forgejo/README.md b/crates/forge-forgejo/README.md new file mode 100644 index 0000000..ddc70e2 --- /dev/null +++ b/crates/forge-forgejo/README.md @@ -0,0 +1,9 @@ +# git-next + +## Trunk-based developement manager. + +`git-next` is a combined server and command-line tool that enables trunk-based +development workflows where each commit must pass CI before being included in +the main branch. + +See [git-next](https://crates.io/crates/git-next) for more information. diff --git a/crates/forge-github/README.md b/crates/forge-github/README.md new file mode 100644 index 0000000..ddc70e2 --- /dev/null +++ b/crates/forge-github/README.md @@ -0,0 +1,9 @@ +# git-next + +## Trunk-based developement manager. + +`git-next` is a combined server and command-line tool that enables trunk-based +development workflows where each commit must pass CI before being included in +the main branch. + +See [git-next](https://crates.io/crates/git-next) for more information. diff --git a/crates/forge/README.md b/crates/forge/README.md new file mode 100644 index 0000000..ddc70e2 --- /dev/null +++ b/crates/forge/README.md @@ -0,0 +1,9 @@ +# git-next + +## Trunk-based developement manager. + +`git-next` is a combined server and command-line tool that enables trunk-based +development workflows where each commit must pass CI before being included in +the main branch. + +See [git-next](https://crates.io/crates/git-next) for more information. diff --git a/crates/git/README.md b/crates/git/README.md new file mode 100644 index 0000000..ddc70e2 --- /dev/null +++ b/crates/git/README.md @@ -0,0 +1,9 @@ +# git-next + +## Trunk-based developement manager. + +`git-next` is a combined server and command-line tool that enables trunk-based +development workflows where each commit must pass CI before being included in +the main branch. + +See [git-next](https://crates.io/crates/git-next) for more information. diff --git a/crates/repo-actor/MESSAGES.md b/crates/repo-actor/MESSAGES.md new file mode 100644 index 0000000..a4f5032 --- /dev/null +++ b/crates/repo-actor/MESSAGES.md @@ -0,0 +1,36 @@ +```mermaid +stateDiagram-v2 +[*] --> CloneRepo :on start + +CloneRepo --> LoadConfigFromRepo :on repo config +CloneRepo --> RegisterWebhook :on server config + +LoadConfigFromRepo --> ReceiveRepoConfig + +ValidateRepo --> CheckCIStatus :on next ahead of main +ValidateRepo --> AdvanceNext :on dev ahead of next +ValidateRepo --> [*] :on dev == next == main +ValidateRepo --> [*] :on non-retryable error +ValidateRepo --> ValidateRepo :on retryable error + +CheckCIStatus --> ReceiveCIStatus + +ReceiveCIStatus --> AdvanceMain :on Pass +ReceiveCIStatus --> ValidateRepo :on Pending +ReceiveCIStatus --> [*] :on Fail + +AdvanceNext --> ValidateRepo + +ReceiveRepoConfig --> RegisterWebhook + +RegisterWebhook --> WebhookRegistered + +WebhookRegistered --> ValidateRepo + +AdvanceMain --> LoadConfigFromRepo :on repo config +AdvanceMain --> ValidateRepo :on server config + +[*] --> WebhookNotification :on push + +WebhookNotification --> ValidateRepo +``` diff --git a/crates/repo-actor/README.md b/crates/repo-actor/README.md index a4f5032..ddc70e2 100644 --- a/crates/repo-actor/README.md +++ b/crates/repo-actor/README.md @@ -1,36 +1,9 @@ -```mermaid -stateDiagram-v2 -[*] --> CloneRepo :on start +# git-next -CloneRepo --> LoadConfigFromRepo :on repo config -CloneRepo --> RegisterWebhook :on server config +## Trunk-based developement manager. -LoadConfigFromRepo --> ReceiveRepoConfig +`git-next` is a combined server and command-line tool that enables trunk-based +development workflows where each commit must pass CI before being included in +the main branch. -ValidateRepo --> CheckCIStatus :on next ahead of main -ValidateRepo --> AdvanceNext :on dev ahead of next -ValidateRepo --> [*] :on dev == next == main -ValidateRepo --> [*] :on non-retryable error -ValidateRepo --> ValidateRepo :on retryable error - -CheckCIStatus --> ReceiveCIStatus - -ReceiveCIStatus --> AdvanceMain :on Pass -ReceiveCIStatus --> ValidateRepo :on Pending -ReceiveCIStatus --> [*] :on Fail - -AdvanceNext --> ValidateRepo - -ReceiveRepoConfig --> RegisterWebhook - -RegisterWebhook --> WebhookRegistered - -WebhookRegistered --> ValidateRepo - -AdvanceMain --> LoadConfigFromRepo :on repo config -AdvanceMain --> ValidateRepo :on server config - -[*] --> WebhookNotification :on push - -WebhookNotification --> ValidateRepo -``` +See [git-next](https://crates.io/crates/git-next) for more information. diff --git a/crates/server-actor/MESSAGES.md b/crates/server-actor/MESSAGES.md new file mode 100644 index 0000000..d84c340 --- /dev/null +++ b/crates/server-actor/MESSAGES.md @@ -0,0 +1,17 @@ +```mermaid +stateDiagram-v2 +SERVER --> FileUpdated :on start +FILE_WATCHER_ACTOR --> FileUpdated : WatchFile + +FileUpdated --> ReceiveServerConfig + +ReceiveServerConfig --> ReceiveValidServerConfig + +ReceiveValidServerConfig --> WEBHOOK_ACTOR:ShutdownWebhook +ReceiveValidServerConfig --> REPO_ACTOR:START +ReceiveValidServerConfig --> REPO_ACTOR:CloneRepo +ReceiveValidServerConfig --> WEBHOOK_ROUTER:START +ReceiveValidServerConfig --> WEBHOOK_ROUTER:AddWebhookRecipient +ReceiveValidServerConfig --> WEBHOOK_ACTOR:START + +``` diff --git a/crates/server-actor/README.md b/crates/server-actor/README.md index d84c340..ddc70e2 100644 --- a/crates/server-actor/README.md +++ b/crates/server-actor/README.md @@ -1,17 +1,9 @@ -```mermaid -stateDiagram-v2 -SERVER --> FileUpdated :on start -FILE_WATCHER_ACTOR --> FileUpdated : WatchFile +# git-next -FileUpdated --> ReceiveServerConfig +## Trunk-based developement manager. -ReceiveServerConfig --> ReceiveValidServerConfig +`git-next` is a combined server and command-line tool that enables trunk-based +development workflows where each commit must pass CI before being included in +the main branch. -ReceiveValidServerConfig --> WEBHOOK_ACTOR:ShutdownWebhook -ReceiveValidServerConfig --> REPO_ACTOR:START -ReceiveValidServerConfig --> REPO_ACTOR:CloneRepo -ReceiveValidServerConfig --> WEBHOOK_ROUTER:START -ReceiveValidServerConfig --> WEBHOOK_ROUTER:AddWebhookRecipient -ReceiveValidServerConfig --> WEBHOOK_ACTOR:START - -``` +See [git-next](https://crates.io/crates/git-next) for more information. diff --git a/crates/server/README.md b/crates/server/README.md new file mode 100644 index 0000000..ddc70e2 --- /dev/null +++ b/crates/server/README.md @@ -0,0 +1,9 @@ +# git-next + +## Trunk-based developement manager. + +`git-next` is a combined server and command-line tool that enables trunk-based +development workflows where each commit must pass CI before being included in +the main branch. + +See [git-next](https://crates.io/crates/git-next) for more information. diff --git a/crates/webhook-actor/README.md b/crates/webhook-actor/README.md new file mode 100644 index 0000000..ddc70e2 --- /dev/null +++ b/crates/webhook-actor/README.md @@ -0,0 +1,9 @@ +# git-next + +## Trunk-based developement manager. + +`git-next` is a combined server and command-line tool that enables trunk-based +development workflows where each commit must pass CI before being included in +the main branch. + +See [git-next](https://crates.io/crates/git-next) for more information.