Viaalink CI/CD · GitHub Action

Werk in je CI-job, vanuit je browser.

Een terminal of VS Code op de runner, en de services van je job op een tijdelijk openbaar adres. Via je eigen Viaalink Relay, achter een login, zolang de job draait.

uses: viaalink/cicd@v2 · Linux-, macOS- en Windows-runners · ook je eigen runners

In het kort

De runner verbindt naar buiten. Jij opent een link.

Tijdens een job publiceert de action een terminal, VS Code of een van je services via je Relay. Op de runner gaat niets open: hij verbindt zelf met je Relay. De sessie zit achter een login, en je Relay serveert haar via HTTPS.

  1. Runner je CI-job
  2. Relay serveert via HTTPS
  3. Login ervoor
    Browser terminal of VS Code

Wat je krijgt

Drie dingen tijdens een CI/CD-job.

  • Een browserterminal op de runner

    De uitgecheckte repository, de toolchain en de omgeving die je pipeline ziet. Voor de job die alleen in CI faalt, of een machine die je niet op je bureau hebt.

  • VS Code op de runner

    Dezelfde sessie met een editor: lees de bestanden, pas ze aan en draai de commando's van de job opnieuw, in een browsertab. Na de login vraagt VS Code nog één keer om een wachtwoord: hetzelfde, tenzij je het een eigen wachtwoord geeft.

  • Je services op tijdelijke adressen

    Een app of API die de job startte krijgt een eigen HTTPS-adres zolang de job draait. Test echte testwebhooks van Mollie of Adyen in CI in plaats van mocks.

Met de Viaalink CLI

Drie commando's naar je eerste sessie.

Draai ze in je repository, op een apparaat dat is aangemeld op je Relay.

  1. 1

    Installeer de workflow

    Schrijft .github/workflows/terminal.yml en bewaart je Relay-sleutel en een terminalwachtwoord als repository-secrets. Het vraagt het eerst.

    via ci install
  2. 2

    Commit en push

    De workflow is een gewoon bestand in je repository. Lees het, pas het aan en review het zoals elk ander bestand.

    git add .github/workflows/terminal.yml
    git commit -m "ci: add terminal workflow"
    git push
  3. 3

    Open een sessie

    Kies het besturingssysteem en de shell, wacht op het adres en open het. Wil je VS Code in plaats van een terminal, voeg dan --interface codeserver toe.

    via gh terminal
    via gh terminal --interface codeserver

Terwijl het draait

Bekijk, heropen en stop je sessies.

Een sessie leeft zolang haar job. Daarna antwoordt het adres met 404.

CommandoWat het doet
via gh activeToont de draaiende sessies met hun adressen.
via gh terminal --show-loginPrint het adres met de login erin. Behandel het als een wachtwoord.
via gh stopStopt een sessie. Het adres antwoordt daarna met 404.
via gh runsToont recente sessies.

Zonder de CLI

Start het vanuit het tabblad Actions.

De workflow is een gewone workflow_dispatch-workflow. Open het tabblad Actions van je repository, kies de workflow Terminal en druk op Run workflow. Kies in het formulier het besturingssysteem, de shell en de interface (terminal of VS Code).

Het adres staat in de samenvatting van de run. Log in met de gebruikersnaam die je koos en het terminalwachtwoord. Dat staat op de machine die via ci install draaide: via gh terminal --show-login print het adres met het wachtwoord erin.

  1. 1 Actions
  2. 2 Terminal
  3. 3 Run workflow
  4. 4 Run summary

In je eigen workflow

Eén stap, waar je hem nodig hebt.

Gebruik de action direct om alleen een sessie te openen als de tests faalden, of om een service te publiceren voor de rest van de job.

Een terminal of VS Code

De stap houdt de job vast zolang de sessie open is. Zet hem als laatste, of achter een voorwaarde zoals een gefaalde teststap. Met interface: codeserver geeft de optionele input codeserver-password VS Code een eigen wachtwoord.

- uses: viaalink/cicd@v2
  with:
    tunnel-key: ${{ secrets.VIA_TUNNEL_KEY }}
    tunnel-key-id: ${{ secrets.VIA_TUNNEL_KEY_ID }}
    tunnel-host: ${{ secrets.VIA_TUNNEL_HOST }}
    tunnel-port: ${{ secrets.VIA_TUNNEL_PORT }}
    tunnel-host-key-fingerprints: ${{ secrets.VIA_TUNNEL_HOST_KEY_FINGERPRINTS }}
    password: ${{ secrets.VIA_TERMINAL_PASSWORD }}
    interface: terminal   # or codeserver for VS Code

Alleen services, voor echte webhooks

Met interface: none en mode: background gaat de stap door en blijft het adres bestaan tot de job eindigt. Een public service heeft geen login: alleen het willekeurige deel van het adres beschermt hem, dus je handler moet elke webhook zelf controleren.

- id: via
  uses: viaalink/cicd@v2
  with:
    tunnel-key: ${{ secrets.VIA_TUNNEL_KEY }}
    tunnel-key-id: ${{ secrets.VIA_TUNNEL_KEY_ID }}
    tunnel-host: ${{ secrets.VIA_TUNNEL_HOST }}
    tunnel-host-key-fingerprints: ${{ secrets.VIA_TUNNEL_HOST_KEY_FINGERPRINTS }}
    interface: none
    mode: background
    expose: |
      3000 webhooks public

- run: npm run test:payments
  env:
    WEBHOOK_URL: ${{ fromJSON(steps.via.outputs.urls).webhooks }}

Waar het draait

De runners van GitHub, of je eigen.

  • Runners van GitHub

    Linux, macOS en Windows.

  • Eigen runners

    Dezelfde sessie op je eigen machines. De runner heeft uitgaande toegang nodig tot je Relay en tot GitHub, niets inkomend.

Goed om te weten

Wat het beschermt, en wat niet.

  • Geef CI een eigen sleutel.

    Wie de terminal opent, kan de Relay-sleutel op de runner lezen. Meld een apparaat alleen voor CI aan, zodat je het van je Relay kunt halen zonder je eigen apparaten te raken.

  • Wie de workflow kan starten, kan een sessie openen.

    Een sessie heeft de secrets van de repository binnen bereik. Houd de workflow bij mensen die je die toegang zou geven.

  • De login wordt gecontroleerd, niet aangenomen.

    Na het publiceren vraagt de action elk adres achter de login op zonder inloggegevens en eist een weigering voordat hij verdergaat.

  • Er blijft niets achter.

    Als de job eindigt, stopt de sessie en antwoorden de adressen met 404.

Lees verder

De referentie en de onderdelen eromheen.