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
In your GitHub repository, go to Settings and scroll down to the GitHub Pages section.
Select gh-pages as the source branch, and
/(root) as the source directory, then click
Save.
On the main branch, open the file
/.github/workflows/github-pages.yaml and update the
on element as follows:
on:
push:
branches: [ 'main' ]
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.
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!