Konfiguration
actrun bietet ein flexibles Konfigurationssystem, das dir ermoeglicht, Werte ueber Programm-Flags, Umgebungsvariablen und Konfigurationsdateien zu setzen.
Die Konfigurationsprioritaet ist strikt hierarchisch. Werte, die weiter oben in der Liste stehen, haben Vorrang vor denen darunter:
1. Programm-Flags (Empfohlen)
Abschnitt betitelt „1. Programm-Flags (Empfohlen)“Der direkteste Weg, actrun zu konfigurieren, ist die Uebergabe von Argumenten und Flags direkt an die ausfuehrbare Datei. Dies ist die Methode mit der hoechsten Prioritaet.
Einen Graph direkt ausfuehren
Abschnitt betitelt „Einen Graph direkt ausfuehren“Um einen bestimmten Action Graph auszufuehren, gib den Dateinamen (oder die URL) als erstes positionales Argument an. Flags nach dem Dateinamen werden direkt als Inputs an deinen Graph weitergegeben.
# Syntax: actrun [options] <filename|url> [graph-flags]
# Einen Graph ausfuehren./actrun my_graph.act
# Einen Graph ausfuehren und Flags uebergeben./actrun my_graph.act --my-flag=test --another-flag=123
# Einen Graph mit eigener Config-Datei ausfuehren und Flags uebergeben./actrun --config-file=/path/to/config.actconfig my_graph.act --my-flag=test --another-flag=123Hinweis: Flags, die spezifisch fuer
actrunsind (wie--config-file), muessen vor dem Graph-Dateinamen stehen. Alles nach dem Dateinamen wird als Argument fuer den Graph selbst behandelt.
Verfuegbare Flags
Abschnitt betitelt „Verfuegbare Flags“| Flag | Beschreibung |
|---|---|
--config-file | Pfad zu einer bestimmten .actconfig-Konfigurationsdatei. |
--concurrency | Konkurrente Ausfuehrung aktivieren oder deaktivieren (Standard: true). |
--session-token | Token zur Verbindung mit einer Debug Session im Browser. |
--create-debug-session | Eine Debug Session durch Verbindung mit der Web-App erstellen. Kann nicht zusammen mit --session-token verwendet werden. |
--env-file | Absoluter Pfad zu einer .env-Datei, die vor der Ausfuehrung geladen wird. |
Hinweis: Bindestriche (
--config-file) und Underscores (--config_file) werden fuer alle Flags akzeptiert.
Unterbefehle
Abschnitt betitelt „Unterbefehle“| Befehl | Beschreibung |
|---|---|
validate [graph-file] | Eine Graph-Datei validieren, ohne sie auszufuehren. |
version | Die Versionsnummer von actrun anzeigen. |
2. Umgebungsvariablen
Abschnitt betitelt „2. Umgebungsvariablen“Du kannst das Runtime-Verhalten konfigurieren und Standardwerte setzen, indem du Umgebungsvariablen verwendest. Das ist nuetzlich fuer CI/CD-Umgebungen oder zum Setzen von Benutzer-Standardwerten.
Graph ueber Umgebung festlegen
Abschnitt betitelt „Graph ueber Umgebung festlegen“Statt den Dateinamen jedes Mal zu uebergeben, kannst du die Variable ACT_GRAPH_FILE setzen.
export ACT_GRAPH_FILE=my_workflow.act./actrunFlags an einen impliziten Graph uebergeben
Abschnitt betitelt „Flags an einen impliziten Graph uebergeben“Wenn du deinen Graph ueber die Umgebungsvariable ACT_GRAPH_FILE festgelegt hast, aber trotzdem Flags an die Runtime uebergeben musst (wie Inputs), musst du den Doppel-Strich-Separator -- verwenden. Das sagt actrun, dass die folgenden Flags zum Graph gehoeren, nicht zum CLI-Tool.
export ACT_GRAPH_FILE=my_workflow.actexport ACT_CONFIG_FILE=my_config.actconfig
# Verwende '--' um Flags an deinen Graph zu uebergeben./actrun -- --my-flag=test --another-flag=123Unterstuetzte Variablen
Abschnitt betitelt „Unterstuetzte Variablen“Du kannst zusaetzliche Variablen aus einer .env-Datei laden, indem du das Flag --env-file verwendest.
| Variable | Aequivalentes Flag | Beschreibung |
|---|---|---|
ACT_GRAPH_FILE | [filename] | Die Standard-Graph-Datei, die ausgefuehrt wird, wenn kein Argument angegeben wird. |
ACT_CONCURRENCY | --concurrency | Konkurrente Ausfuehrung aktivieren oder deaktivieren (Standard: true). |
ACT_CONFIG_FILE | --config-file | Pfad zu einer bestimmten .actconfig-Datei. |
ACT_SESSION_TOKEN | --session-token | Token zur Verbindung mit einer Debug Session im Browser. |
ACT_CREATE_DEBUG_SESSION | --create-debug-session | Eine Debug Session durch Verbindung mit der Web-App erstellen. |
ACT_LOGLEVEL | — | Log-Level setzen (debug, verbose oder Standard). |
ACT_NOCOLOR | — | Auf true setzen, um Farbe im Terminal zu deaktivieren. |
3. Konfigurationsdateien (.actconfig)
Abschnitt betitelt „3. Konfigurationsdateien (.actconfig)“Du kannst YAML-Konfigurationsdateien verwenden, um Umgebungsvariablen und Secrets zu speichern. Du kannst entweder eine bestimmte Config-Datei angeben oder actrun nach einer globalen Config in deinem Home-Verzeichnis suchen lassen.
- Lokal: Eine bestimmte Datei, bereitgestellt ueber das Flag
--config-fileoder die UmgebungsvariableACT_CONFIG_FILE. - Global: Eine
.actconfig-Datei in deinem Home-Verzeichnis (~/.actconfig).
Ordner~/ Home-Verzeichnis
- .actconfig globale Config
Ordneryour-project/
- .actconfig lokale Config
- my-workflow.act
Beispiel-Inhalt einer actconfig:
env: # Diese Variablen sind fuer deinen Graph verfuegbar API_ENDPOINT: https://api.example.com DEFAULT_REGION: us-east-1secrets: # Secrets werden sicher dem Secret Node zur Verfuegung gestellt API_KEY: abcdef123456 DB_PASSWORD: super_secret_passwordinputs: # Inputs sind als Graph-Eingaben verfuegbar DEPLOYMENT_ENV: productionDebug Output
Abschnitt betitelt „Debug Output“Um genau zu sehen, woher Konfigurationswerte beim Start geladen werden, setze die Umgebungsvariable ACT_LOGLEVEL auf debug.
export ACT_LOGLEVEL=debug./actrun --concurrency=falselooking for value: 'concurrency' found value in flags evaluated to: 'false'Secret-Verwaltung
Abschnitt betitelt „Secret-Verwaltung“Secrets sollten niemals ueber Kommandozeilen-Flags uebergeben werden. Verwende stattdessen Umgebungsvariablen oder definiere sie in deiner Config-Datei unter dem Schluessel secrets.
Secrets sind ueber den 🔑 Secret Node zugaenglich. Du kannst auch direkt in den Inputs eines -Ports ueber die Expressions-Syntax darauf zugreifen.
GitHub Actions Workflows
Abschnitt betitelt „GitHub Actions Workflows“Wenn du actrun in einem GitHub Actions Workflow ausfuehrst, kannst du Repository-Secrets im JSON-Format in den Graph-Kontext uebergeben:
Ordner.github/
Ordnerworkflows/
- my-gh-workflow.yml Workflow-YAML
- my-workflow.act Action Graph
jobs: build-quick: runs-on: ubuntu-latest name: Run Graph steps: - name: Run Graph uses: actionforge/action@866e7df1ce5e84a2b32fda7414812ae72000dae8 # v0.14.6 with: graph_file: my-workflow.act # (1)
inputs: ${{toJson(inputs) }} secrets: ${{toJson(secrets) }} # (2) matrix: ${{toJson(matrix) }} needs: ${{toJson(needs) }}- Speichere deinen Graph hier:
.github/workflows/my-workflow.act. - ℹ️ Fuege diese Zeile hinzu, um den Zugriff auf deine Repository- oder Organisations-Secrets im Action Graph zu ermoeglichen.