ghpages

静的アセットを GitHub ページにデプロイするための GitHub アクション

このアクションは非推奨になりました。 GitHub による公式の GitHub アクションを使用した GitHub Pages への公開が「ネイティブ」でサポートされるようになりました。このアプローチよりもはるかに優れています。

このアクションでは、ワークフローの作業ディレクトリ ( /github/workspace ) から静的コンテンツの任意のフォルダーを GitHub ページにデプロイするだけです。これは、選択したアセット フォルダー ( BUILD_DIR ) をアクション インスタンスで GitHub リポジトリのgh-pagesブランチにgit push 、 gh-pagesブランチが提供されるようにすることで機能します。このアクションを組織またはユーザー リポジトリ ( username/username.github.ioという名前) 内で実行している場合は、代わりにmasterブランチにデプロイされます。

リポジトリ設定の調整が必要な場合もあることに注意してください。

このアクションは別の「デプロイ専用」ブランチにデプロイされるため、 docs/などのリポジトリのサブディレクトリからデプロイする場合はこのアクションを使用できません。このような場合、ビルド アーティファクトを自分でコミットすることになるため、実際には GitHub アクションは必要ありません。詳細については、GitHub Pages のドキュメントを参照してください。

静的サイト ジェネレーターを使用してGitHub ページにデプロイするための優れた GitHub アクションがすでに存在します (jekyll、jekyll、zola、そして今後さらに多くのアクションが追加されるでしょう)。これらの作品から git アクションの多くを借用しましたが、このアクションはそれではありません。

このアクションでは何もビルドされず、デプロイされるだけです。

入力

なし。

出力

なし。

秘密

GitHub ページへのデプロイはgh-pages (またはmaster ) ブランチにgit pushことによって行われます。これを承認するには、GitHub アクションにシークレットが必要です。現時点では、多少混乱しますが、すべてのリポジトリで利用可能なGITHUB_TOKEN 、 gh-pagesにプッシュするには十分ですが、GitHub 上でページのビルドをトリガーしたり、コンテンツを GitHub コンテンツ配信ネットワークに伝播したりするのには十分ではありません。

したがって、外部サービス (Travis など) の場合と同じように、カスタムのパーソナル アクセス トークン (PAT) を作成する必要があります。 Github Pages にデプロイするには、このトークンをrepo権限で作成する必要があります。次に、このトークンをGH_PAT (リポジトリ設定/シークレット) という名前でシークレットとして GitHub UI に貼り付け、以下のようにアクションで呼び出す必要があります。

私は 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 }}