Déployer votre portail avec GitHub Pages - Cloud

Guide de déploiement de Talend Cloud API Portal

EnrichVersion
Cloud
EnrichProdName
Talend Cloud
EnrichPlatform
Talend API Designer
task
Création et développement > Création d'APIs

Le déploiement de GitHub Pages peut être activé directement dans Talend Cloud API Designer, mais vous pouvez également l'activer manuellement après génération de votre dépôt. Pour plus d'informations, consultez la documentation GitHub.

Avant de commencer

  • Vous avez généré le dépôt de votre API Portal.
  • Vous avez un plan GitHub vous permettant de publier vers GitHub Pages à partir d'un dépôt privé.

Procédure

  1. Dans votre dépôt GitHub, allez dans Settings et faites défiler jusqu'à la section GitHub Pages.
  2. Sélectionnez gh-pages comme branche source et /(root) comme répertoire source, puis cliquez sur Save.
  3. Dans la branche principale main, ouvrez le fichier /.github/workflows/github-pages.yaml et mettez à jour l'élément on comme suit :
    on:
      push:
        branches: [ 'main' ]
  4. Effectuez un commit de vos modifications.

Résultats

Une fois le commit de la modification apportée à github-pages.yaml effectué, l'Action GitHub correspondante doit s'exécuter. Elle construit le contenu de votre branche main et effectue un push de ce contenu vers la branche gh-pages, utilisée pour déployer votre portail. L'URL est disponible dans la section GitHub Pages, dans les paramètres.