Добавляет код для сборки APK на CI и сохранения его (#46)

* Добавляет код для сборки APK на CI и сохранения его * Добавляет документацию про настройку Github Actions
Yandex-Practicum · Nov 29, 2023 · 14ff87e · 14ff87e
1 parent 84a17e2
commit 14ff87e
Show file tree

Hide file tree

Showing 10 changed files with 83 additions and 0 deletions.
diff --git a/.github/workflows/pr_checks.yml b/.github/workflows/pr_checks.yml
@@ -68,5 +68,17 @@ jobs:
             -   name: Grant execute permission for gradlew
                 run: chmod +x gradlew
 
+            -   name: Setup environment
+                env:
+                    GH_HH_ACCESS_TOKEN: ${{ secrets.GH_HH_ACCESS_TOKEN }}
+                run: |
+                    sh ci/setup_env.sh
+
             -   name: Assemble app
                 run: ./gradlew :app:assembleDebug $commonGradleFlags
+
+            -   name: Archive production artifacts
+                uses: actions/upload-artifact@v3
+                with:
+                    name: app-debug.apk
+                    path: app/build/outputs/apk/debug/app-debug.apk
diff --git a/README.md b/README.md
@@ -37,6 +37,70 @@ hhAccessToken=my_access_token
 Также в проекте настроена команда, которая исправляет большое количество ошибок форматирования detekt. Чтобы запустить
 её, откройте терминал и выполните команду `./gradlew detektFormat`.
 
+## Настройка Github Actions
+
+В дипломном проекте используется сервис [Github Actions](https://github.com/features/actions) для настройки CI (
+Continuous Integration). Это позволяет автоматизировать базовые проверки качества приложения, такие как компиляция
+проекта и прогон статического анализатора [detekt](https://github.com/detekt/detekt). Файл конфигурации CI вы
+можете [найти здесь](./.github/workflows/pr_checks.yml).
+
+На каждый созданный pull request CI-сервер:
+
+- Скомпилирует проект и соберёт APK приложения, описанного в модуле `app`. Готовый APK можно скачивать на свой телефон
+  или передавать на тестирование другим разработчикам или ревьюверам.
+- И запустит статический анализатор `detekt`, чтобы подсветить наличие или отсутствие ошибок, которые можно обнаружить,
+  не запуская приложение. В частности, это поможет вам соблюдать принятый на проекте код-стайл.
+
+Чтобы автоматические проверки могли запускаться на каждый созданный pull request, необходимо сделать несколько
+дополнительных действий:
+
+- Активировать `Github Actions` в вашем форке дипломного проекта.
+- И добавить токен API HeadHunter в секреты репозитория.
+
+### Шаг 1 - Активация Github Actions
+
+По умолчанию Github отключает настроенные `Github Actions` для каждого форка оригинального репозитория. Это сделано для
+того, чтобы каждый разработчик и разработчица осознанно применяли описанные конфигурации CI (мало ли что настроено в
+оригинальном репозитории!).
+
+Чтобы активировать `Github Actions` в форке дипломного проекта, необходимо зайти во вкладку `Actions`:
+
+![Вкладка "Actions"](./docs/img/github_actions_setup__actions_tab.png)
+
+А затем нажать на зелёную кнопку - так вы даёте своё согласие на запуск описанных в репозитории
+файлов-конфигураций `Github Actions`:
+
+![Зелёная кнопка согласия](./docs/img/github_actions_setup__workflow_button.png)
+
+### Шаг 2 - Добавление токена API HeadHunter в секреты проекта
+
+Файл `develop.properties` не хранится в истории коммитов, однако значение токена API HeadHunter необходимо для успешной
+сборки APK приложения. Чтобы CI-сервер смог получить значение токена, его нужно добавить
+в [секреты репозитория для Github Actions](https://docs.github.com/ru/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository).
+
+Откройте вкладку `Settings` с главной страницы форка:
+
+![Вкладка "Settings"](./docs/img/github_actions_setup__settings_tag.png)
+
+В левой части экрана найдите раздел `Security`, в нём есть пункт `Secrets and variables` (цифра (1) на скриншоте). При
+нажатии на этот пункт появится выпадающий список, в котором будет элемент списка `Actions` (цифра (2) на скриншоте).
+
+![Security -> Secrets and variables -> Actions](./docs/img/github_actions_setup__action_secrets.png)
+
+Нажмите на этот элемент списка и в правой части экрана вы увидите блок, который называется `Repository secrets`:
+
+![Пустой Repository secrets](./docs/img/github_actions_setup__no_repository_secrets.png)
+
+Нажмите на кнопку `New repository secret`. В появившемся окне в качестве названия секрета укажите `GH_HH_ACCESS_TOKEN`,
+а в качестве значения укажите тот же токен, что вы добавляли в файл `develop.properties`:
+
+![Добавление нового секрета](./docs/img/github_actions_setup__new_repository_secret.png)
+
+После ввода ключа и значения нажмите кнопку `Add secret`. Если вы всё сделали правильно, то вы должны увидеть
+обновлённый блок `Repository secrets`:
+
+![Секрет успешно добавлен](./docs/img/github_actions_setup__added_repository_secret.png)
+
 # Техническое задание
 
 Дипломный проект представляет собой небольшое приложение для поиска работы,

diff --git a/ci/setup_env.sh b/ci/setup_env.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+
+envs="
+hhAccessToken=${GH_HH_ACCESS_TOKEN}
+"
+
+(echo "$envs" | grep -E '.+=.+') >> develop.properties
diff --git a/docs/img/github_actions_setup__action_secrets.png b/docs/img/github_actions_setup__action_secrets.png
diff --git a/docs/img/github_actions_setup__actions_tab.png b/docs/img/github_actions_setup__actions_tab.png
diff --git a/docs/img/github_actions_setup__added_repository_secret.png b/docs/img/github_actions_setup__added_repository_secret.png
diff --git a/docs/img/github_actions_setup__new_repository_secret.png b/docs/img/github_actions_setup__new_repository_secret.png
diff --git a/docs/img/github_actions_setup__no_repository_secrets.png b/docs/img/github_actions_setup__no_repository_secrets.png
diff --git a/docs/img/github_actions_setup__settings_tag.png b/docs/img/github_actions_setup__settings_tag.png
diff --git a/docs/img/github_actions_setup__workflow_button.png b/docs/img/github_actions_setup__workflow_button.png