OSCHINA-MIRROR/yanglbme-gitee-pages-action

Ян Л. в своём репозитории на GitHub создал действие для автоматического развёртывания Gitee Pages.

Если вы уже отправили свой код в Gitee, то можете использовать это действие без применения действия wearerequired/git-mirror-action и без настройки переменной GITEE_RSA_PRIVATE_KEY.

Параметр branch по умолчанию равен master. Если вы развертываете код на gh-pages (или main), обязательно укажите branch: gh-pages (или branch: main).
Соответствующая ветка должна существовать в репозитории. Не указывайте произвольную ветку, иначе сайт Gitee Pages может стать недоступным с ошибкой 404.
Для параметра gitee-repo, если ваш проект находится на Gitee по адресу https://gitee.com/имя пользователя/xxx, укажите gitee-repo как имя пользователя/xxx.
В качестве триггера рабочего процесса можно указать другие события. Например:
```
on:
  push:
    branches: [main, master]
```
Подробнее о событиях, запускающих рабочий процесс, см. в документации.

2. Настройка ключей

Шаги по настройке ключей:

a. Сгенерируйте SSH-ключ с помощью команды ssh-keygen -t rsa -C "youremail@example.com" в командной строке или Git Bash. Замените адрес электронной почты на свой. Созданный id_rsa — это закрытый ключ, а id_rsa.pub — открытый ключ. (⚠️Обратите внимание, что здесь не следует устанавливать пароль. Открытый и закрытый ключи используются для конфигурации GitHub / Gitee для обеспечения соответствия друг другу, в противном случае синхронизация из GitHub в Gitee завершится неудачно.)

b. Настройте два ключа в настройках проекта GitHub: «Settings -> Secrets» как GITEE_RSA_PRIVATE_KEY и GITEE_PASSWORD. GITEE_RSA_PRIVATE_KEY содержит закрытый ключ id_rsa, а GITEE_PASSWORD — пароль учетной записи Gitee.

c. На странице настроек личного профиля GitHub «Settings -> SSH and GPG keys» настройте SSH-открытый ключ (id_rsa.pub) с произвольным именем.

d. На странице личных настроек Gitee «Безопасность -> SSH-ключи» настройте открытый SSH-ключ (id_rsa.pub) с произвольным именем.

3. Подписка на официальный аккаунт Gitee

Подпишитесь на официальный аккаунт Gitee и привяжите свою личную учетную запись Gitee для получения уведомлений о входе и обхода проверки SMS-кода.

4. Результаты выполнения

При успешной настройке и запуске действия Gitee Pages Action будет выведено сообщение об успешном выполнении. Также мы получим уведомление о входе в личный кабинет Gitee. Это действие программы Gitee Pages, которая авторизует нас на сайте Gitee и нажимает кнопку «Развертывание» в нашем проекте.

Run yanglbme/gitee-pages-action@main
  with:
    gitee-username: yanglbme
    gitee-password: ***
    gitee-repo: doocs/leetcode
    branch: main
    https: true
/usr/bin/docker run --name e28490f27de0ee43bb49109a40cea0e43202d2_d4911a --label e28490 --workdir /github/workspace --rm -e INPUT_GITEE-USERNAME -e INPUT_GITEE*** INPUT_GITEE-REPO -e INPUT_BRANCH -e INPUT_DIRECTORY -e INPUT_HTTPS -e HOME -e GITHUB_JOB -e GITHUB_REF -e GITHUB_SHA -e GITHUB_REPOSITORY -e GITHUB_REPOSITORY_OWNER -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RETENTION_DAYS -e GITHUB_RUN_ATTEMPT -e GITHUB_ACTOR -e GITHUB_WORKFLOW -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GITHUB_EVENT_NAME -e GITHUB_SERVER_URL -e GITHUB_API_URL -e GITHUB_GRAPHQL_URL -e GITHUB_REF_NAME -e GITHUB_REF_PROTECTED -e GITHUB_REF_TYPE -e GITHUB_WORKSPACE -e GITHUB_ACTION -e GITHUB_EVENT_PATH -e GITHUB_ACTION_REPOSITORY -e GITHUB_ACTION_REF -e GITHUB_PATH -e GITHUB_ENV -e RUNNER_OS -e RUNNER_ARCH -e RUNNER_NAME -e RUNNER_TOOL_CACHE -e RUNNER_TEMP -e RUNNER_WORKSPACE -e ACTIONS_RUNTIME_URL -e ACTIONS_RUNTIME_TOKEN -e ACTIONS_CACHE_URL -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/_temp/_runner_file_commands":"/github/file_commands" -v "/home/runner/work/leetcode/leetcode":"/github/workspace" e28490:f27de0ee43bb49109a40cea0e43202d2
[2021-11-27 20:16:30] Welcome to use Gitee Pages Action ❤

📕 Getting Started Guide: https://github.com/marketplace/actions/gitee-pages-action
📣 Maintained by Yang Libin: https://github.com/yanglbme

[2021-11-27 20:16:34] Login successfully

*Примечание: часть текста была переведена автоматически с использованием машинного перевода.* ```

<img src="./images/action.png" alt="action_result">

<img src="./images/wechat_notification.jpg" alt="add_ssh_key_gitee" style="width: 750px; height: 1334px;" />

## Ошибки и решения

| #   | Ошибка                                                                                                                                                                                                                                                                                                                                       | Решение                                                                                                                                                                                                                                                          |
| --- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1   | Error: Wrong username or password, login failed .                                                                                                                                                                                                                                                                                             | Проверьте правильность параметров `gitee-username` и `gitee-password`.                                                                                                                                                                                              |
| 2   | Error: Need captcha validation, please visit https://gitee.com/login, login to validate your account.                                                                                                                                                                                                                                                  | Необходимо пройти проверку с помощью картинки. Можно вручную войти на официальный сайт Gitee и проверить код.                                                                                                                                                 |
| 3   | Error: Need phone captcha validation, please follow wechat official account "Gitee" to bind account to turn off authentication.                                                                                                                                                                                                                        | Требуется проверка с помощью SMS-кода. Можно подписаться на официальный аккаунт Gitee в WeChat и привязать к нему свой аккаунт Gitee для отключения аутентификации. [#6](https://github.com/yanglbme/gitee-pages-action/issues/6)                                                |
| 4   | Error: Do not deploy frequently, try again one minute later.                                                                                                                                                                                                                                                                                           | Частые попытки развёртывания Gitee Pages приводят к ошибке. Попробуйте выполнить автоматическое развёртывание позже.                                                                                                                                                   |
| 5   | Error: Deploy error occurred, please re-run job or check your input `gitee-repo`. | Произошла ошибка при развёртывании. Перезапустите задание или проверьте ввод `gitee-repo`.
``` | **gitee-repo** параметр формата doocs/leetcode, и строго различайте регистр, пожалуйста, заполните точно. |
|---|
| 6 | Ошибка: Произошла неизвестная ошибка в методе входа, ответ: ... |
| 7 | Ошибка: Ошибка перестроения страницы, код состояния: xxx |
| 8 | Ошибка: HTTPSConnectionPool(host='gitee.com', port=443): время ожидания чтения истекло. (время ожидания чтения = 6)<br><br>Ошибка: HTTPSConnectionPool(host='gitee.com', port=443): превышено максимальное количество попыток с URL: /login (вызвано ConnectTimeoutError(<urllib3.connection.HTTPSConnection object at 0x7f6c889d42e8>, 'Подключение к gitee.com истекло по времени. (время подключения = 6)')) |
| 9 | Ошибка: Владелец репозитория не аутентифицирован и не имеет разрешения на развёртывание сервисов страниц. |
| 10 | git@github.com: Отказано в доступе (publickey).<br>fatal: Не удалось прочитать из удалённого репозитория.<br>Пожалуйста, убедитесь, что у вас есть правильные права доступа и репозиторий существует. |
| 11 | Проблемы с автоматическим развёртыванием сайта Hexo Gitee Pages. |
| 12 | "/root/.ssh/id_rsa": недопустимый формат. ## Кто использует

| **Кто** |
| --- |
| <table>  
    <tr>
        <td align="center" style="width: 80px;">
            <a href="https://github.com/antvis">
                <img src="./images/antv.png" style="width: 40px;" alt="蚂蚁金服"><br>
                <sub>蚂蚁金服 - 数据可视化</sub>
            </a>
        </td>
        <td align="center" style="width: 80px;">
            <a href="https://github.com/doocs">
                <img src="./images/doocs.png" style="width: 40px;" alt="Doocs"><br>
                <sub>Doocs 技术社区</sub>
            </a>
        </td>
         <td align="center" style="width: 80px;">
            <a href="https://github.com/Kaiyiwing/qwerty-learner">
                <img src="./images/qwerty-learner-logo.svg" style="width: 40px;" alt="Qwerty Learner"><br>
                <sub>Qwerty Learner</sub>
            </a>
        </td>
    </tr>
    <tr>
        <td style="width: 80px; text-align: left;">
            <ul>
                <li><a href="https://github.com/antvis/g">antvis/g</a></li>
                <li><a href="https://github.com/antvis/F2">antvis/F2</a></li>
                <li><a href="https://github.com/antvis/G6">antvis/G6</a></li>
                <li><a href="https://github.com/antvis/L7">antvis/L7</a></li>
                <li><a href="https://github.com/antvis/G2Plot">antvis/G2Plot</a></li>
                <li><a href="https://github.com/antvis/Graphin">antvis/Graphin</a></li>
                <li><a href="https://github.com/antvis/antvis.github.io">antvis/antvis.github.io</a></li>
            </ul>
        </td>
        <td style="width: 80px; text-align: left;">
            <ul>
                <li><a href="https://github.com/doocs/jvm">doocs/jvm</a></li>
                <li><a href="https://github.com/doocs/leetcode">doocs/leetcode</a></li>
                <li><a href="https://github.com/doocs/advanced-java">doocs/advanced-java</a></li>
                <li><a href="https://github.com/doocs/doocs.github.io">doocs/doocs.github.io</a></li>
                <li><a href="https://github.com/doocs/source-code-hunter">doocs/source-code-hunter</a></li>
            </ul>
        </td>
        <td style="width: 80px; text-align: left;">
            <ul>
                <li><a href="https://github.com/Kaiyiwing/qwerty-learner" style="white-space: nowrap">Qwerty Learner</a></li>
                <li><a href="https://github.com/Kaiyiwing/qwerty-learner-vscode" style="white-space: nowrap">Qwerty Learner VSCode</a></li>
            </ul>
        </td>
    </tr>
</table>

## Свяжитесь со мной

Если у вас есть какие-либо вопросы о Gitee Pages Action, вы также можете найти меня следующими способами.

<table>
  <tr>
    <td align="center" style="width: 260px;">
      <img src="https://cdn-doocs.oss-cn-shenzhen.aliyuncs.com/gh/doocs/images/qrcode-for-doocs.png" style="width: 400px;"><br>
    </td>
    <td align="center" style="width: 260px;">
      <img src="https://cdn-doocs.oss-cn-shenzhen.aliyuncs.com/gh/doocs/images/qrcode-for-yanglbme.png" style="width: 400px;"><br>
    </td>
  </tr>
</table>

## Лицензия

MIT