diff --git a/.github/workflows/architecture/README.md b/.github/workflows/architecture/README.md new file mode 100644 index 0000000000..88d6f4b269 --- /dev/null +++ b/.github/workflows/architecture/README.md @@ -0,0 +1,7 @@ +# CI Documentation + +## Releases + +```mermaid + +``` diff --git a/.github/workflows/architecture/release-process.png b/.github/workflows/architecture/release-process.png deleted file mode 100644 index 662f334763..0000000000 Binary files a/.github/workflows/architecture/release-process.png and /dev/null differ diff --git a/.github/workflows/architecture/release-process.puml b/.github/workflows/architecture/release-process.puml deleted file mode 100644 index 307091d6aa..0000000000 --- a/.github/workflows/architecture/release-process.puml +++ /dev/null @@ -1,47 +0,0 @@ -@startuml -participant User as user -participant Github as github -participant "Create Release WF" as create -participant "Build WFs" as build -participant "Finalize Release WF" as finalize -participant Discord as discord - -==Nightly Release== - -user -> github : New Commit on master (from PR, or directly) -...waiting for commit push event to fire... -github -> create : Push a new git tag, patch incrementing latest Version -alt from-pr? case - create -> create : Use links to the PR as a description -else was a commit - create -> create : Use Commit Message as Description -end -create -> create : Generate release notes -create -> github : Create new draft release, associated with tag and with the notes -note right -Draft releases are not public facing, only those with write access can see them! -end note -...waiting for push tag event to fire... -loop for all build workflows -github -> build : Build the tag commit -build -> build : .exe will use the git tag for it's title and such -build -> build : Upload the generated artifact to the associated release -alt all-artifacts-uploaded? case - build -> github : Publish the release - user -> github : Can now download the artifacts on the published release -end -note right -This is the only area where an eventual consistency issue is apparent -It is because GitHub does not fire events for when draft releases are edited -This is glossed over in the initial impl and can be improved and be made eventually consistent as well -end note - - -...waiting for release publish event to fire... -github -> finalize : Announce the Release -finalize -> github : Gather all asset links, and format message embed. -finalize -> discord : Announce new build via a WebHook - -...waiting for announcement... -user -> discord : Can download artifacts from links via the discord -@enduml diff --git a/.github/workflows/update-controller-db.yml b/.github/workflows/cron_update_controller_db.yml similarity index 100% rename from .github/workflows/update-controller-db.yml rename to .github/workflows/cron_update_controller_db.yml diff --git a/.github/workflows/lint-gamedb.yml b/.github/workflows/lint_gamedb.yml similarity index 100% rename from .github/workflows/lint-gamedb.yml rename to .github/workflows/lint_gamedb.yml diff --git a/.github/workflows/release-announce.yml b/.github/workflows/release_announce.yml similarity index 100% rename from .github/workflows/release-announce.yml rename to .github/workflows/release_announce.yml diff --git a/.github/workflows/pr-triage.yml b/.github/workflows/triage_pr.yml similarity index 100% rename from .github/workflows/pr-triage.yml rename to .github/workflows/triage_pr.yml