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.
- In your GitHub repository, go to Settings and scroll down to the GitHub Pages section.
gh-pagesas the source branch, and
/(root)as the source directory, then click Save.
mainbranch, open the file /.github/workflows/github-pages.yaml and update the
onelement as follows:
on: push: branches: [ 'main' ]
- Commit your changes.
Once the edit to github-pages.yaml is committed, the corresponding GitHub Action should run. It builds the content from your
mainbranch and pushes it to the
gh-pagesbranch, which is used to deploy your portal. The URL is available in the GitHub Pages section in the settings.