Deploying your portal with GitHub Pages - Cloud

Talend Cloud API Portal Deployment Guide
Version
Cloud
Language
English
Product
Talend Cloud
Module
Talend API Designer
Content
Design and Development > Designing APIs
Last publication date
2024-03-14

The GitHub Pages deployment can be enabled directly in Talend Cloud API Designer, but you can also do it manually after generating your repository. For more information, see the GitHub documentation.

Before you begin

  • You have generated your API Portal repository.
  • You have a GitHub plan that allows you to publish to GitHub Pages from a private repository.

Procedure

  1. In your GitHub repository, go to Settings and scroll down to the GitHub Pages section.
  2. Select gh-pages as the source branch, and /(root) as the source directory, then click Save.
    GitHub Pages section.
  3. On the main branch, open the file /.github/workflows/github-pages.yaml and update the on element as follows: 
    on:
  push:
    branches: [ 'main' ]
  4. Commit your changes.

Results

Once the edit to github-pages.yaml is committed, the corresponding GitHub Action should run. It builds the content from your main branch and pushes it to the gh-pages branch, which is used to deploy your portal. The URL is available in the GitHub Pages section in the settings.
In this example, the URL https://company.github.io/api-portal/ is available in the GitHub Pages section.