Distribuera en Fabric-app med GitHub Actions

Automatisera distributioner av en Fabric app från en GitHub-lagringsplats till en Fabric arbetsyta med hjälp av ett GitHub Actions arbetsflöde. Arbetsflödet loggar in på Fabric med tjänstens huvudnamn, installerar Rayfin CLI och kör rayfin up för att tillämpa koden, databasschemat och statiskt innehåll på målarbetsytan. Den här artikeln visar hur du gör följande:

  • Förbered ett huvudnamn för tjänsten och en Fabric arbetsyta för automatiserade distributioner.
  • Konfigurera GitHub-lagringsplatsens hemligheter som arbetsflödet behöver.
  • Lägg till arbetsflödesfilen för distributionen till lagringsplatsen.
  • Utlösa distributioner automatiskt på main och manuellt med valfritt stöd för destruktiva ändringar.
  • Återanvänd samma arbetsflöde för funktionsgrenar och miljöspecifika distributioner.

Förutsättningar

  • Ett Fabric appprojekt på en GitHub lagringsplats. Om du inte har ett ännu kan du läsa Skapa ditt första Fabric Apps-projekt och push-överföra programkoden till lagringsplatsen.
  • En Fabric-arbetsyta som tjänsthuvudnamnet kan distribuera till. Information om miljöavgränsning finns i Hantera utvecklings- och prod-miljöer.
  • Ett tjänsthuvudnamn i Microsoft Entra ID (appregistrering) med en klienthemlighet.
  • Behörighet att lägga till secrets till GitHub-lagringsplatsen.

Steg 1: Skapa ett huvudnamn för tjänsten för distributioner

Arbetsflödet loggar in utan användarinteraktion, så det använder ett tjänsthuvudnamn i stället för ett interaktivt användarkonto.

  1. I portalen Azure registrerar du ett nytt program under Microsoft Entra ID>App registrations.
  2. Registrera applikations-ID (klient-ID) och katalog-ID (hyresgäst-ID).
  3. Under Certifikat och hemligheter skapar du en ny klienthemlighet och kopierar värdet. Lagra den på ett säkert sätt: du kan inte visa den igen senare.
  4. Bevilja tjänstens huvudkonto behörigheten Contributor eller högre på målarbetsytan i Fabric så att det kan skapa och uppdatera appobjektet i Fabric.

Important

Distributioner av tjänstens huvudnamn kräver Fabric klientinställningar som gör att tjänstens huvudnamn kan använda Fabric API:er. Bekräfta med din Fabric administratör att detta är aktiverat.

Steg 2: Lägga till lagringsplatshemligheter

Gå till Settings>Hemligheter och variabler>Actions i GitHub-lagringsplatsen och lägg till följande hemligheter för lagringsplatsen:

Hemligt namn Value
CLIENT_ID Applikations-ID:t (klient) för tjänsthuvudnamnet.
TENANT_ID Katalogtjänstens ID (klientorganisation).
CLIENT_SECRET Värdet för klienthemligheten.
FABRIC_WORKSPACE_NAME Namnet på målarbetsytan Fabric (till exempel my-app-prod).

Steg 3: Lägg till arbetsflödesfilen

Skapa filen .github/workflows/deploy-to-fabric.yml med följande innehåll på lagringsplatsen:

name: Deploy to Fabric

on:
  push:
    branches: [main]
  workflow_dispatch:
    inputs:
      force:
        description: 'Allow destructive schema changes that may result in data loss'
        required: false
        default: false
        type: boolean

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  deploy:
    name: Deploy to Fabric
    runs-on: ubuntu-latest
    env:
      CLIENT_ID: ${{ secrets.CLIENT_ID }}
      TENANT_ID: ${{ secrets.TENANT_ID }}
      CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }}
      FABRIC_WORKSPACE_NAME: ${{ secrets.FABRIC_WORKSPACE_NAME }}

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '20'

      - name: Install Rayfin CLI
        run: npm install -g @microsoft/rayfin-cli

      - name: Login to Rayfin with service principal
        run: |
          rayfin login \
            --service-principal \
            -t $TENANT_ID
            -u $CLIENT_ID
            -p CLIENT_SECRET

      - name: Deploy to Fabric
        run: |
          EXTRA_ARGS=""

          if [[ "${{ inputs.force }}" == "true" ]]; then
            EXTRA_ARGS="$EXTRA_ARGS --force"
          fi

          rayfin up \
            --workspace "$FABRIC_WORKSPACE_NAME" \
            --yes \
            $EXTRA_ARGS

Vad varje avsnitt gör

  • on.push: Kör arbetsflödet automatiskt vid varje push-överföring till main.
  • on.workflow_dispatch: Lägger till en Kör arbetsflöde-knapp i GitHub Actions-gränssnittet med en tvinga-kryssruta. Om du aktiverar force skickas --force till rayfin up, vilket gör att destruktiva schemaändringar (som att ta bort kolumner eller tabeller) tillåts. Låt den vara avmarkerad för säkra, icke-destruktiva driftsättningar.
  • concurrency: Säkerställer att endast en distribution per gren körs i taget. Om en ny push kommer in medan en tidigare driftsättning fortfarande körs avbryts den äldre körningen till förmån för den nyare committen. Den här inställningen förhindrar att två rayfin up jobb körs på samma arbetsyta.
  • env: Skickar autentiseringsuppgifterna för tjänstens huvudkonto och namnet på målarbetsytan till jobbet.
  • Install Rayfin CLI: Installerar CLI globalt så rayfin är på PATH.
  • Login to Fabric with service principal: Autentiserar med hjälp av miljövariablerna *.
  • Deploy to Fabric: Kör rayfin up mot den konfigurerade tenanten och arbetsytan. --yes accepterar icke-destruktiva uppmaningar; --force läggs bara till när den manuella körningen begärde det.

Steg 4: Utlösa en distribution

Du kan utlösa arbetsflödet på två sätt:

  • Automatiskt: Skicka eller sammanfoga en incheckning till grenen main .
  • Manuellt: I GitHub går du till Actions>Distribuera till Fabric>Kör arbetsflöde. Välj den gren som ska driftsättas och markera eventuellt tillåt destruktiva schemaändringar som kan leda till dataförlust innan du startar körningen.

När arbetsflödet är klart skriver steget Deploy to Fabric i körningsloggen ut Fabric app-URL:en och distributions-ID:t.

Överväganden och begränsningar

  • Samtidighet är per gren. concurrency.group innehåller github.ref, så distributioner till olika grenar avbryter inte varandra. Det här beteendet är avsiktligt när du mappar grenar till olika arbetsytor.
  • Destruktiva ändringar blockeras som standard. rayfin up nekar schemaåtgärder som kan förlora data om de inte --force skickas. Aktivera endast force vid en manuell körning när du har granskat de planerade åtgärderna.
  • Arbetsytor måste finnas. Arbetsflödet skapar inte Fabric arbetsytor. Skapa dem i Fabric-portalen och bevilja först tjänsthuvudnamnet åtkomst.