DevInCi instellen in GitHub Actions

Als een GitHub Actions job faalt is de gebruikelijke workflow: logs lezen, gokken, fix pushen, wachten, herhalen. DevInCi vervangt die cyclus met een live terminal of VS Code IDE in de runner zelf. Je klikt op een URL en debugt in exact de omgeving waar de failure optrad.

Wat je krijgt

• Web terminal (ttyd) — volledige shell in je browser, geen SSH keys
• VS Code (code-server) — browser IDE met extensies en debugger
• Beveiligde tunnel URL — HTTPS met ingebedde credentials, deelbaar met teamleden
• Auto-provisioning — credentials, tunnel server en URL worden automatisch afgehandeld

De action is beschikbaar op de GitHub Marketplace — zoek naar "ASD DevInCi" of ga naar github.com/marketplace/actions/asd-devinci. Werkt op Ubuntu, macOS en Windows runners.

Vereisten

• Een ASD account (asd.host/workspace)
• Een API key met cicd:provision scope
• Een GitHub repository met Actions ingeschakeld

Stap 1: Maak een API key

1. Ga naar asd.host/workspace/api-keys
2. Klik op Create API Key
3. Activeer de cicd:provision scope
4. Kopieer de key — je ziet deze niet meer

Stap 2: Voeg de key toe als repository secret

1. Ga naar je repository → Settings → Secrets and variables → Actions
2. Klik op New repository secret
3. Name: ASD_API_KEY
4. Value: plak je API key

Stap 3: Voeg DevInCi toe aan je workflow

Voeg de DevInCi stap toe na je test commando. Deze draait alleen als de vorige stap faalt:

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: npm ci
      - run: npm test

      - name: DevInCi — Debug on failure
        if: failure()
        uses: asd-engineering/asd-devinci@v1
        with:
          api-key: ${{ secrets.ASD_API_KEY }}

Dat is alles. Als de test stap faalt start DevInCi een web terminal en print een URL in de job logs.

Stap 4: Open de sessie

Wanneer je workflow faalt, doet DevInCi automatisch:

1. ASD CLI installeren
2. Tunnel credentials aanmaken via je API key
3. Web terminal (ttyd) starten
4. Beveiligde tunnel verbinden
5. Sessie URL printen in de job logs

Klik op de URL om een live terminal te openen in je browser. De credentials zitten in de URL, dus authenticatie is automatisch. Secrets worden gemaskeerd in logs via ::add-mask::.

VS Code in plaats van terminal

Stel de interface input in op codeserver voor een volledige VS Code IDE:

- name: DevInCi — VS Code on failure
  if: failure()
  uses: asd-engineering/asd-devinci@v1
  with:
    api-key: ${{ secrets.ASD_API_KEY }}
    interface: codeserver
    tunnel-name: vscode-${{ github.run_id }}

On-demand sessies

Trigger DevInCi handmatig in plaats van te wachten op een failure. Maak een aparte workflow met workflow_dispatch:

name: Development Environment

on:
  workflow_dispatch:
    inputs:
      ttl:
        description: 'Sessie duur (minuten)'
        default: '30'

jobs:
  dev:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: npm install

      - name: Start DevInCi
        uses: asd-engineering/asd-devinci@v1
        with:
          api-key: ${{ secrets.ASD_API_KEY }}
          interface: codeserver
          tunnel-name: dev-${{ github.actor }}
          ttl-minutes: ${{ github.event.inputs.ttl }}

Ga naar je repository → Actions → selecteer de workflow → Run workflow.

Debug een specifieke falende job

Gebruik continue-on-error om de workflow draaiend te houden na een test failure, en check dan de outcome:

jobs:
  debug:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Run tests
        id: tests
        run: npm test
        continue-on-error: true

      - name: Start DevInCi on failure
        if: steps.tests.outcome == 'failure'
        uses: asd-engineering/asd-devinci@v1
        with:
          api-key: ${{ secrets.ASD_API_KEY }}
          tunnel-name: debug-${{ github.run_id }}

Action outputs gebruiken

DevInCi biedt outputs die je kunt gebruiken in volgende stappen:

- name: Start DevInCi
  id: devinci
  if: failure()
  uses: asd-engineering/asd-devinci@v1
  with:
    api-key: ${{ secrets.ASD_API_KEY }}

- name: Notify team
  if: failure()
  run: |
    echo "Debug URL: ${{ steps.devinci.outputs.url }}"
    echo "Verloopt: ${{ steps.devinci.outputs.expires-at }}"

Output	Beschrijving
url	Sessie URL met ingebedde credentials
url-base	Sessie URL zonder credentials
tunnel-user	Tunnel client ID
local-port	Lokale service poort
expires-at	Token expiratie (ISO 8601)

Configuratie opties

Input	Beschrijving	Default
api-key	ASD API key met cicd:provision scope	—
interface	ttyd (terminal) of codeserver (VS Code)	ttyd
shell	bash, zsh of powershell	bash
username	Basic auth gebruikersnaam	asd
password	Basic auth wachtwoord (automatisch gegenereerd als leeg)	—
tunnel-name	Subdomein prefix	Korte SHA
ttl-minutes	Sessie TTL in minuten (0 = geen expiry)	0
region	Tunnel server regio	Auto

Troubleshooting

"Failed to provision credentials"

1. Controleer of je API key de cicd:provision scope heeft
2. Check of de key niet verlopen is
3. Bevestig dat ASD_API_KEY is ingesteld in repository secrets

"Tunnel connection failed"

1. Controleer of de runner uitgaande SSH op poort 2223 toestaat
2. Probeer een andere regio als beschikbaar

Samenvatting

Voeg de asd-engineering/asd-devinci action toe aan elke workflow. Als een job faalt, klik op de URL en debug in exact de runner omgeving. Geen SSH keys, geen handmatige setup.