GitHub Actions-Quickverwijzing – Standaardstructuur en een lijst met de meest nuttige acties

GitHub Actions is een automatiserings- en CI/CD-platform binnen GitHub, dat wordt gebruikt om code te bouwen, te testen en te implementeren op basis van gebeurtenissen zoals pushes, pull requests of volgens een schema.

Naast standaard GitHub kun je GitHub Actions ook gebruiken in een zelf-gehoste Gitea-server.

Actions omvatten officiële, community- en externe tools, die automatisering ondersteunen van builds en tests tot implementatie, beheer van releases, QA en meldingen.

Dit overzicht behandelt de structuur van GitHub Actions, een korte beschrijving en de meest gebruikte actions in open source- en commerciële workflows. Het maakt deel uit van Developer Tools: De Complete Gids voor Moderne Ontwikkelingsworkflows.

Basisconfiguratiestructuur

GitHub Actions Workflows worden gedefinieerd in YAML-bestanden die zich bevinden in de .github/workflows-map binnen de repository.

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

• Het on-blok specificeert triggergebeurtenissen.
• Elke job wordt op zijn eigen runner uitgevoerd.
• steps kunnen shell-opdrachten uitvoeren of herbruikbare actions aanroepen.

Kerncomponenten van Workflows

Triggergebeurtenissen

• push
• pull_request
• schedule (gebruikmakend van cron-syntax)
• workflow_dispatch (handmatige trigger, stelt inparameters in)
• release, issue, etc.

Voorbeeld:

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

Nuttige Ingebouwde Actions

Action Parameters

Algemene Parameters voor Elke Action-oproep:

- 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: argumenten die aan de action worden doorgegeven (zie de action-documentatie voor alle opties)
• env: omgevingsvariabelen voor de step
• if: conditionele uitvoering
• run: shell-opdrachten (als je geen action gebruikt)
• shell: shell die wordt gebruikt om de step uit te voeren
• continue-on-error: doorgaan ook als de step faalt

Aangepaste Action-inputs definiëren

In je action-metadata (action.yml):

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

Wanneer gebruikt in een workflow:

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

Wordt opgehaald als omgevingsvariabele INPUT_EXAMPLE_INPUT wanneer de action wordt uitgevoerd.

Voorbeeld: Workflow met Handmatige Parameters

name: Deploy
on:
  workflow_dispatch:
    inputs:
      environment:
        description: 'Deployment Environment'
        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 }}"

Action Marketplace

• Duizenden herbruikbare actions zijn beschikbaar in de GitHub Marketplace.
• Categorieën omvatten: cloud-implementaties, meldingstools, testframeworks, code-analyse en meer.
• Verken: actions/checkout, actions/setup-node, docker/build-push-action, actions/cache, actions/upload-artifact en vele anderen.

Snelle Tips

• Plaats workflow-bestanden in .github/workflows.
• Gebruik workflow_dispatch met inputs voor handmatige en geparametriseerde runs.
• Gebruik de cache-action om het installeren van afhankelijkheden te versnellen.
• Gebruik job matrix om meerdere besturingssysteem- en runtimeversies te testen.
• Gebruik secrets voor gevoelige gegevens, verwezen als ${{ secrets.SECRET_NAME }}.

Deze cheat-sheet behandelt de basics van het gebruik, configureren en uitbreiden van GitHub Actions voor automatisering, CI/CD en meer. Voor meer details en updates, raadpleeg altijd de officiële GitHub-documentatie en action-repositories.

Veelgebruikte GitHub Actions

Hier is een praktische lijst met veelgebruikte GitHub Actions die helpen bij het automatiseren van CI/CD, testen, bouwen, implementeren en workflow-taken:

Kern Officiële Actions

Populaire Community- en Derden-Actions

Test-, QA- en Rapportage-Actions

Implementatie- en Melding-Actions

Hulpmiddelen & Workflow-beheer

Hoe vind je meer?

Er zijn veel GitHub Actions die workflow-automatisering mogelijk maken, zoals geautomatiseerd testen, implementatie naar productie, meldingen en integraties met andere diensten. De GitHub Marketplace lijst duizenden actions op over categorieën zoals testen, beveiliging, implementatie, meldingen, codekwaliteit en integraties. Gecureerde lijsten zoals “Awesome Actions” zijn ook geweldig voor inspiratie en ontdekking.

Nuttige links

• 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 Cheat-sheet
• Gitea - installeren en testen
• Gitea-server back-uppen en herstellen
• Hugo-website implementeren naar AWS S3 met Gitea Actions
• Gitflow: Stappen, Alternatieven, Voordelen en Nadelen
• DevOps met GitOps - Argo CD, Flux, Jenkins X, Weave GitOps en anderen