GitHub Actions Cheatsheet - Standardstruktur och en lista över de mest användbara åtgärderna

GitHub Actions är en automatiserings- och CI/CD-plattform inom GitHub, som används för att bygga, testa och distribuera din kod baserat på händelser som push, pull requests eller på ett schema.

Förutom standard GitHub kan du använda GitHub Actions i en self-hosted Gitea-server.

Denna sammanfattning täcker GitHub Actions struktur, kort beskrivning och de vanligaste åtgärderna som används i öppna källkods- och kommersiella arbetsflöden. Åtgärder omfattar officiella, community- och tredjepartsverktyg, som stöder automatisering från byggande och tester till distribution, versionshantering, QA och notiser.

Grundläggande Konfigurationsstruktur

GitHub Actions Workflows definieras i YAML-filer som finns i katalogen .github/workflows i repositoryt.

name: Workflow Name
on:
  push:
    branches: [ main ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'
      - name: Run tests
        run: npm test

• Blocket on anger utlösande händelser.
• Varje job körs på sin egen runner.
• steps kan köra shell-kommandon eller kalla återanvändbara åtgärder.

Grundläggande Arbetsflödeskomponenter

Utlösande Händelser

• push
• pull_request
• schedule (använder cron-syntax)
• workflow_dispatch (manuell utlösning, tillåter inmatningsparametrar)
• release, issue, etc.

Exempel:

on:
  push:
    branches: [ main ]
  workflow_dispatch:
    inputs:
      environment:
        description: 'Distributionsmiljö'
        required: true
        default: 'production'
        type: string

Användbara Inbyggda Åtgärder

Åtgärdsparametrar

Allmänna parametrar för alla åtgärdskall

- name: Some Action or Step
  uses: owner/repo@ref
  with:
    param1: value
    param2: value
  env:
    ENV_VAR: value
  if: ${{ condition }}
  run: command_to_run
  shell: bash|pwsh|python|sh
  continue-on-error: true|false

• with: argument som skickas till åtgärden (se åtgärdens dokumentation för alla alternativ)
• env: miljövariabler för steget
• if: villkorlig körning
• run: shell-kommandon (om inte en åtgärd används)
• shell: shell som används för att köra steget
• continue-on-error: fortsätt även om steget misslyckas

Definiera Anpassade Åtgärdsinmatningar

I din åtgärdsmetadata (action.yml):

inputs:
  example-input:
    description: 'An example input'
    required: false
    default: 'default-value'

När det används i ett arbetsflöde:

- uses: my/action@v1
  with:
    example-input: 'custom-value'

Åtkomlig som miljövariabel INPUT_EXAMPLE_INPUT när åtgärden körs.

Exempel: Arbetsflöde med Manuella Parametrar

name: Deploy
on:
  workflow_dispatch:
    inputs:
      environment:
        description: 'Distributionsmiljö'
        required: true
        default: 'production'
        type: string
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Deploy to environment
        run: echo "Deploying to ${{ github.event.inputs.environment }}"

Åtgärdsmarknad

• Tusentals återanvändbara åtgärder finns tillgängliga i GitHub Marketplace.
• Kategorier inkluderar: molndistributioner, notiseringsverktyg, testramverk, kodanalys och mer.
• Utforska: actions/checkout, actions/setup-node, docker/build-push-action, actions/cache, actions/upload-artifact, och många andra.

Snabba Tips

• Placera arbetsflödesfiler i .github/workflows.
• Använd workflow_dispatch med inputs för manuella och parameteriserade körningar.
• Använd cache åtgärd för att påskynda beroendeinstallationer.
• Använd job matrix för att testa flera OS/körningsversioner.
• Använd hemligheter för känslig data, refererad som ${{ secrets.SECRET_NAME }}.

Denna snabbguide täcker grunderna för att använda, konfigurera och utöka GitHub Actions för automatisering, CI/CD och mer. För mer detaljer och uppdateringar, kontrollera alltid den officiella GitHub-dokumentationen och åtgärdsrepository.

Vanliga GitHub Actions

Här är en praktisk lista över vanligt använda GitHub Actions som hjälper till att automatisera CI/CD, testning, byggande, distribution och arbetsflödesuppgifter:

Grundläggande officiella åtgärder

Populära community- och tredjepartsåtgärder

Testning, QA och rapporteringsåtgärder

Distributions- och notifieringsåtgärder

Användbarhets- och arbetsflödeshanteringsåtgärder

Hur man hittar fler

Det finns många GitHub Actions som möjliggör arbetsflödesautomatisering såsom automatiserad testning, distribution till produktion, notifieringar och integrationer med andra tjänster. GitHub Marketplace listar tusentals åtgärder inom kategorier som testning, säkerhet, distribution, notifieringar, kodkvalitet och integrationer. Kuraterade listor som “Awesome Actions” är också bra för inspiration och upptäckt.

Användbara länkar

• https://docs.github.com/actions
• https://github.com/marketplace
• https://docs.github.com/en/actions/get-started/quickstart
• https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
• GIT Cheatsheet
• Gitea - installation och testning
• Backup och återställning av Gitea-server
• Använda Gitea Actions för att distribuera Hugo-webbplats till AWS S3
• Gitflow: steg, alternativ, fördelar och nackdelar
• DevOps med GitOps - Argo CD, Flux, Jenkins X, Weave GitOps och andra