From f6855df818194ece96b3d78f8b157f42000d87e7 Mon Sep 17 00:00:00 2001 From: juliangiebel Date: Sat, 12 Oct 2024 23:50:52 +0200 Subject: [PATCH 1/4] Add hotfix howto --- src/en/wizden-staff/maintainer/hotfix-procedure.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/en/wizden-staff/maintainer/hotfix-procedure.md b/src/en/wizden-staff/maintainer/hotfix-procedure.md index bc9031c4c..f6fdc1f62 100644 --- a/src/en/wizden-staff/maintainer/hotfix-procedure.md +++ b/src/en/wizden-staff/maintainer/hotfix-procedure.md @@ -11,3 +11,11 @@ Not following this procedure/policy will result in disiplinary action being take - Whether a PR should be classifed as a bug fix or not is up to the maintainers reviewing the PR. But in general, a bug fix adjusts existing content/code to fix an issue without dramatically changing the game or adding new content. - Balancing changes are usually not bug fixes. A balancing change adjusts tuning values on a gameplay system/mechanic to change gameplay to be more in line with the intended experience. If the experience before the change is still playable then the balancing change is not a bug fix, however if the gameplay is *causing major issues for players/admins* then a balancing change can be considered as a bugfix in this case. +## Creating and applying a hotfix +A hotfix needs to be based on the branch the bug appears in. +During the release phase bugs on staging need to be fixed using hotfixes based on staging and vice versa. +The hotfix branch needs to be merged into the affected branch (staging/live) and then into master. + +If a bug needs to be fixed on live during the release cycle the hotfix branch needs to be based on live and then merged into staging and master. + +This will eventually be done by a github action or a bot automatically. \ No newline at end of file From 72bfe10e69faf259eac2b2c1caf2c7c73c0f9acf Mon Sep 17 00:00:00 2001 From: juliangiebel Date: Sun, 13 Oct 2024 23:14:33 +0200 Subject: [PATCH 2/4] Improve hotfix documentation --- .../maintainer/hotfix-procedure.md | 54 +++++++++++++++++-- 1 file changed, 51 insertions(+), 3 deletions(-) diff --git a/src/en/wizden-staff/maintainer/hotfix-procedure.md b/src/en/wizden-staff/maintainer/hotfix-procedure.md index f6fdc1f62..3bbd93bea 100644 --- a/src/en/wizden-staff/maintainer/hotfix-procedure.md +++ b/src/en/wizden-staff/maintainer/hotfix-procedure.md @@ -14,8 +14,56 @@ Not following this procedure/policy will result in disiplinary action being take ## Creating and applying a hotfix A hotfix needs to be based on the branch the bug appears in. During the release phase bugs on staging need to be fixed using hotfixes based on staging and vice versa. -The hotfix branch needs to be merged into the affected branch (staging/live) and then into master. +A PR needs to be made for the hotfix branch for the affected branch (staging/stable) and for master. -If a bug needs to be fixed on live during the release cycle the hotfix branch needs to be based on live and then merged into staging and master. +If a bug needs to be fixed on stable during the release phase the hotfix branch needs to be based on stable and then a PR needs to be made for staging and master. -This will eventually be done by a github action or a bot automatically. \ No newline at end of file +When a bug needs to be hotfixed on stable outside of the release phase the hotfix needs to be based on stable and then a PR needs to be made for stable and master + +This will eventually be done by a github action or a bot automatically. + +### Bug appears on staging during release cycle +- Branch of off the staging branch +```shell +git checkout staging +git branch -b "" +``` +- Implement the hotfix +- Push the hotfix branch +```shell +git push HEAD +``` +- Create and merge a PR for the staging branch +- Create and merge a PR for the master branch +- Delete the hotfix branch + +### Bug appears on stable during release cycle +- Branch of off the stable branch +```shell +git checkout stable +git branch -b "" +``` +- Implement the hotfix +- Push the hotfix branch +```shell +git push HEAD +``` +- Create and merge a PR for the stable branch +- Create and merge a PR for the staging branch +- Create and merge a PR for the master branch +- Delete the hotfix branch + +### Bug appears on stable outside release cycle +- Branch of off the stable branch +```shell +git checkout stable +git branch -b "" +``` +- Implement the hotfix +- Push the hotfix branch +```shell +git push HEAD +``` +- Create and merge a PR for the stable branch +- Create and merge a PR for the master branch +- Delete the hotfix branch \ No newline at end of file From 312b9f0e1f1b7230861126a1503bf48efec981a5 Mon Sep 17 00:00:00 2001 From: juliangiebel Date: Sun, 13 Oct 2024 23:24:29 +0200 Subject: [PATCH 3/4] Improve wording around creating the hotfix branch --- src/en/wizden-staff/maintainer/hotfix-procedure.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/en/wizden-staff/maintainer/hotfix-procedure.md b/src/en/wizden-staff/maintainer/hotfix-procedure.md index 3bbd93bea..eb7d0f2bb 100644 --- a/src/en/wizden-staff/maintainer/hotfix-procedure.md +++ b/src/en/wizden-staff/maintainer/hotfix-procedure.md @@ -12,9 +12,9 @@ Not following this procedure/policy will result in disiplinary action being take - Balancing changes are usually not bug fixes. A balancing change adjusts tuning values on a gameplay system/mechanic to change gameplay to be more in line with the intended experience. If the experience before the change is still playable then the balancing change is not a bug fix, however if the gameplay is *causing major issues for players/admins* then a balancing change can be considered as a bugfix in this case. ## Creating and applying a hotfix -A hotfix needs to be based on the branch the bug appears in. +A hotfix needs to be created based on the branch the bug appears in. During the release phase bugs on staging need to be fixed using hotfixes based on staging and vice versa. -A PR needs to be made for the hotfix branch for the affected branch (staging/stable) and for master. +A PR needs to be made for the newly created hotfix branch for the branch the bug appeared on (staging/stable) and for master. If a bug needs to be fixed on stable during the release phase the hotfix branch needs to be based on stable and then a PR needs to be made for staging and master. From bfd14ccfcea32db1477ecdabcbee44bf25fe11a7 Mon Sep 17 00:00:00 2001 From: juliangiebel Date: Mon, 14 Oct 2024 14:20:20 +0200 Subject: [PATCH 4/4] Fix wrong checkout new branch command --- src/en/wizden-staff/maintainer/hotfix-procedure.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/en/wizden-staff/maintainer/hotfix-procedure.md b/src/en/wizden-staff/maintainer/hotfix-procedure.md index eb7d0f2bb..f58d007fc 100644 --- a/src/en/wizden-staff/maintainer/hotfix-procedure.md +++ b/src/en/wizden-staff/maintainer/hotfix-procedure.md @@ -26,7 +26,7 @@ This will eventually be done by a github action or a bot automatically. - Branch of off the staging branch ```shell git checkout staging -git branch -b "" +git checkout -b "" ``` - Implement the hotfix - Push the hotfix branch @@ -41,7 +41,7 @@ git push HEAD - Branch of off the stable branch ```shell git checkout stable -git branch -b "" +git checkout -b "" ``` - Implement the hotfix - Push the hotfix branch @@ -57,7 +57,7 @@ git push HEAD - Branch of off the stable branch ```shell git checkout stable -git branch -b "" +git checkout -b "" ``` - Implement the hotfix - Push the hotfix branch