actions netlify

Aktionen netlify

GitHub -Aktionen für die Bereitstellung für Netlify

Bereitstellung von URLs werden zu Ihren Pull -Anfragen kommentiert und Kommentare begehen!

GitHub -Bereitstellungen werden ebenfalls unterstützt!

Verwendung

 # .github/workflows/netlify.yml
name : Build and Deploy to Netlify
on :
  push :
  pull_request :
jobs :
  build :
    runs-on : ubuntu-22.04
    steps :
      - uses : actions/checkout@v4

      # ( Build to ./dist or other directory... )

      - name : Deploy to Netlify
        uses : nwtgck/[email protected]
        with :
          publish-dir : ' ./dist '
          production-branch : master
          github-token : ${{ secrets.GITHUB_TOKEN }}
          deploy-message : " Deploy from GitHub Actions "
          enable-pull-request-comment : false
          enable-commit-comment : true
          overwrites-pull-request-comment : true
        env :
          NETLIFY_AUTH_TOKEN : ${{ secrets.NETLIFY_AUTH_TOKEN }}
          NETLIFY_SITE_ID : ${{ secrets.NETLIFY_SITE_ID }}
        timeout-minutes : 1

Erforderliche Eingaben und Env

• publish-dir (zB "dist", "_Site")
• NETLIFY_AUTH_TOKEN : Personal Access Tokens> Neues Zugriffstoken
• NETLIFY_SITE_ID : Team Seite> Ihre Site> Einstellungen> Site -Details> Site -Informationen> API -ID
  • Hinweis: Die API -ID ist NETLIFY_SITE_ID .

Optionale Eingaben

• production-branch (zB "Master")
• production-deploy : Bereitstellung als Netlify-Produktionsbereitstellung (Standard: Falsch)
• github-token: ${{ secrets.GITHUB_TOKEN }}
• deploy-message Eine benutzerdefinierte Bereitstellungsnachricht, die auf der Netlify-Bereitstellung angezeigt werden soll (z. B. ${{ github.event.pull_request.title }} )
• enable-pull-request-comment: true Kommentar zur Pull-Anfrage (Standard: TRUE)
• enable-commit-comment: true Kommentar zum GitHub Commit (Standard: TRUE)
• enable-commit-status: true GitHub Commit Status (Standard: TRUE)
• overwrites-pull-request-comment: true Overwrites Kommentar zur Pull-Anfrage (Standard: True)
• netlify-config-path: ./netlify.toml path zu netlify.toml (Standard: undefiniert)
• functions-dir Netlify-Funktionen Ausgabeverzeichnis (Standard: undefiniert)
• alias ​​gibt das Präfix für die Bereitstellungs -URL an, darf keine Großbuchstaben oder Sonderzeichen haben (Standard: netlify Build -ID)
  • alias: ${{ github.head_ref }} reproduziert das Branch -Bereitstellen -Präfix
  • alias: deploy-preview-${{ github.event.number }} repliziert das Vorschau-Präfix für die Bereitstellung
• enable-github-deployment ob auf GitHub bereitgestellt werden soll (Standard: TRUE)
• github-deployment-environment -Umgebungsname der Github-Bereitstellungen
• github-deployment-description Beschreibung des Github-Bereitstellungsverhältnisses
• fails-without-credentials fehl, wenn keine Anmeldeinformationen angegeben sind (Standard: Falsch)

Pfade sind relativ zur Wurzel des Projekts

Alle Pfade (z. B. publish-dir , netlify-config-path , functions-dir ) sind relativ zu den Wurzel- oder Absolutpfaden des Projekts.

Ausgänge

• deploy-url URL

Auf lokaler Aufbau

npm ci
npm run all