Przeglądaj źródła

Добавил инфу об очистке кэша (#3161)

1vanK 3 lat temu
rodzic
commit
23baf2a433
2 zmienionych plików z 23 dodań i 0 usunięć
  1. 21 0
      .github/clear_cache.md
  2. 2 0
      .github/contributing.md

+ 21 - 0
.github/clear_cache.md

@@ -0,0 +1,21 @@
+# Очистка кэша CMake
+
+Два события запускают workflow [main](workflows/main.yml), компилирующий движок:
+* `push`, когда коммиты отправляются в репозиторий
+* `pull_request`, когда создаётся PR с коммитами из другого репозитория или ветки
+
+При `push` GitHub предоставляет
+[массив `commits` с информацией о коммитах](https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#push)
+(максимальная длина массива - 20 коммитов), поэтому достаточно чтобы в названии или описании любого
+коммита имелась фраза `[clear cache]`.
+
+При `pull_request` изучение коммитов является сложной задачей.
+Во первых GitHub не предоставляет массива с информацией о коммитах. Во вторых
+коммиты из PR будут перемешаны с коммитами, которые были добавлены в master
+за время работы над PR. Поэтому для PR фразу `[clear cache]` нужно добавить в
+заголовок PR.
+
+Если вы создали PR без `[clear cache]`, а потом обнаружили, что требуется очистка кэша,
+то недостаточно просто переименовать PR и перезапустить worflow. После переименования нужно
+добавить в PR новый коммит или переоткрыть PR
+(нажать кнопку `Close pull request`, а потом `Reopen pull request`).

+ 2 - 0
.github/contributing.md

@@ -2,3 +2,5 @@
 1) Ваш PR соответствует [перечисленным требованиям](https://urho3d-doxygen.github.io/latest/_contribution_checklist.html)
 2) Стиль вашего кода соответствует [стандарту оформления кода](https://urho3d-doxygen.github.io/latest/_coding_conventions.html)
 3) Вы обязуетесь сопровождать ваш код после принятия в основную ветку
+
+Про очистку кэша CMake читайте [тут](clear_cache.md).