GitHub Pagesでポータルをデプロイ

GitHub PagesのデプロイメントはTalend Cloud API Designerで直接有効にできますが、リポジトリーを生成した後に手動で行うことも可能です。詳細は、GitHubのドキュメンテーションを参照してください。

始める前に

API Portalリポジトリーをが生成済みであること。
プライベートリポジトリーからGitHub Pagesに公開できGitHubプランがあること。

手順

GitHubリポジトリーで[Settings] (設定)に移動し、GitHub Pagesセクションまでスクロールダウンします。
ソースブランチとしてgh-pagesを、ソースディレクトリーとして/(root)を選択し、[Save] (保存)をクリックします。
mainブランチで/.github/workflows/github-pages.yamlファイルを開き、onエレメントを次のようにアップデートします。
```
on:
  push:
    branches: [ 'main' ]
```
変更をコミットします。

タスクの結果

github-pages.yamlの編集がコミットされると、対応するGitHubアクションが実行されます。これによってmainブランチからのコンテンツがビルドされ、gh-pagesブランチにプッシュされます。このコンテンツはポータルのデプロイに使われます。URLは設定のGitHub Pagesセクションで確認できます。

この例では、GitHub Pagesセクションでhttps://company.github.io/api-portal/というURLを利用できます。

このページは役に立ちましたか?

このページまたはコンテンツに、タイポ、ステップの省略、技術的エラーなどの問題が見つかった場合は、お知らせください。改善に役立たせていただきます。

こちらにフィードバックをお寄せください