ghpages

Действие GitHub для развертывания статических ресурсов на страницах GitHub

Это действие устарело. Теперь есть «встроенная» поддержка публикации на страницах GitHub с использованием официального действия GitHub от GitHub. Это намного лучше, чем этот подход.

Это действие просто позволяет вам развернуть произвольные папки со статическим контентом из рабочего каталога вашего рабочего процесса ( /github/workspace ) на страницах GitHub. Это работает, когда ваш экземпляр действия git push выбранную вами папку ресурсов ( BUILD_DIR ) в ветку gh-pages вашего репозитория GitHub для обслуживания ветки gh-pages . Если вы выполняете это действие внутри организации или репозитория пользователей (с именем username/username.github.io ), вместо этого оно будет развернуто в master ветке.

Помните, что вам также может потребоваться изменить настройки вашего репозитория.

Поскольку это действие развертывается в отдельных ветках, предназначенных только для развертывания, вы не можете использовать его, если хотите развернуть из подкаталога репозитория, такого как docs/ . В этих случаях вам действительно не нужно действие GitHub, потому что вы сами будете фиксировать артефакты сборки. Подробности см. в документации GitHub Pages.

Уже есть отличные действия GitHub по использованию генераторов статических сайтов с последующим развертыванием на страницах GitHub (для jekyll, jekyll, zola и, конечно же, для многих других). Это действие не такое, хотя я позаимствовал большую часть действий git из этих работ.

Это действие ничего не строит, оно просто развертывает.

Входы

Никто.

Выходы

Никто.

Секреты

Развертывание на страницах GitHub происходит путем git push в ветку gh-pages (или master ). Чтобы авторизовать это, действию GitHub нужен секрет. На данный момент, что несколько сбивает с толку, GITHUB_TOKEN доступный для каждого репозитория , достаточен для отправки на gh-pages , но недостаточен для запуска сборки страницы на GitHub или даже для распространения контента в сеть доставки контента GitHub.

Поэтому вам необходимо создать собственный токен личного доступа (PAT) так же, как вы это делаете для внешних служб (скажем, Travis). Этот токен должен быть создан с разрешениями repo для его развертывания на страницах Github. Затем вам нужно вставить этот токен в пользовательский интерфейс GitHub в качестве секрета под именем GH_PAT (настройки/секреты репозитория) и вызвать его в действии, как показано ниже.

Я попросил GitHub упростить этот процесс. Обсуждение задокументировано здесь.

Переменные среды

Просто BUILD_DIR — каталог сборки относительно корня вашего репозитория. Вы также можете пройти . если вы хотите отправить корень вашего репозитория.

Пример использования

 name : Deployment

" on " :
  - push
  - pull_request

jobs :
  deploy_ghpages :
    runs-on : ubuntu-18.04
    steps :
      - uses : actions/checkout@v1
      - run : echo $GITHUB_SHA >> public/index.html
      - uses : maxheld83/[email protected]
        env :
          BUILD_DIR : public/
          GH_PAT : ${{ secrets.GH_PAT }}