Repository navigation
docs(uipath-coded-apps): add environment variables guidance #7378
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Test Helpers | |
| on: | |
| # No `paths:` filter on purpose, for the same two reasons as | |
| # validate-version-sync.yml, validate-skills-sh.yml and smoke-rpa-skills.yml: | |
| # | |
| # 1. Required-check safety: these jobs are wired as required status checks. | |
| # If `paths:` excluded a PR the workflow wouldn't run, no check would be | |
| # reported, and merge would block forever. Every job here is a checkout, | |
| # a Python setup and a sub-30s pytest run, so just always run them. | |
| # 2. A path list is not a reliable trigger for the regressions these guard. | |
| # The checkers under test import from `tests/`, `scripts/` and `hooks/`, | |
| # and a suite can break from an edit to a file no list anticipated — the | |
| # same way validate-skills-sh.yml's old filter stayed silent on #2252, | |
| # the PR that introduced the very drift that guard exists to catch. | |
| pull_request: | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| jobs: | |
| pytest-bpmn-check: | |
| runs-on: uipath-ubuntu-latest | |
| name: maestro-bpmn checker unit tests | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest pyyaml | |
| - name: Run pytest | |
| run: pytest tests/tasks/uipath-maestro-bpmn/ -v | |
| pytest-flow-check: | |
| runs-on: uipath-ubuntu-latest | |
| name: maestro-flow checker unit tests | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest | |
| - name: Run pytest | |
| run: pytest tests/tasks/uipath-maestro-flow/ -v | |
| pytest-admin-check: | |
| runs-on: uipath-ubuntu-latest | |
| name: uipath-admin verify negative controls | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest | |
| # These are the negative controls for the uipath-admin verify scripts: they | |
| # assert each verify FAILS on wrong tenant state, and that a degenerate seed | |
| # fails loudly instead of skipping. Without this job the harness silently | |
| # drifted from the verify scripts it guards — a synthetic payload shape kept | |
| # 29/29 green while the real parser read nothing (see PR #2667). | |
| - name: Run pytest | |
| run: pytest tests/tasks/uipath-admin/_shared/ -v | |
| pytest-case-check: | |
| runs-on: uipath-ubuntu-latest | |
| name: maestro-case checker unit tests | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest pyyaml | |
| # test_tenant_catalog.py fails when a case task gains a tenant dependency | |
| # that no disposition rule in tests/scripts/tenant_catalog.py classifies. | |
| - name: Run pytest | |
| run: pytest tests/tasks/uipath-maestro-case/ tests/scripts/test_tenant_catalog.py -v | |
| # Covers the Automation Hub publish graders and the `.uip-recorder` shim the | |
| # live tasks run behind, offline: a stub stands in for the real CLI, so these | |
| # test the call log and its grading, never tenant behaviour. | |
| pytest-automationhub-check: | |
| runs-on: uipath-ubuntu-latest | |
| name: uipath-automationhub checker unit tests | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest | |
| - name: Run pytest | |
| run: pytest tests/tasks/uipath-automationhub/ -v | |
| # Covers the case-design eval checkers migrated from uipath-maestro-case | |
| # (planner-sole-SDD-author) plus the sdd_check twin-sync guard. | |
| pytest-planner-check: | |
| runs-on: uipath-ubuntu-latest | |
| name: uipath-planner checker unit tests | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest | |
| # The genome checker, contract and SDD fingerprint tests need Node; they run in the genome checker job below. | |
| - name: Run pytest | |
| run: pytest tests/tasks/uipath-planner/ -v --ignore=tests/tasks/uipath-planner/_shared/test_genome_check.py --ignore=tests/tasks/uipath-planner/_shared/test_genome_check_findings.py --ignore=tests/tasks/uipath-planner/_shared/test_genome_contract.py --ignore=tests/tasks/uipath-planner/_shared/test_sdd_fingerprint.py | |
| - name: Run SDD caller-contract guard | |
| run: pytest tests/scripts/test_planner_sdd_contract.py -v | |
| pytest-agents-check: | |
| runs-on: uipath-ubuntu-latest | |
| name: uipath-agents checker unit tests | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest | |
| - name: Run pytest | |
| run: pytest tests/tasks/uipath-agents/ -v | |
| pytest-review-check: | |
| runs-on: uipath-ubuntu-latest | |
| name: uipath-review checker unit tests | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest | |
| - name: Run pytest | |
| run: pytest tests/tasks/uipath-review/ -v | |
| pytest-coded-apps-check: | |
| runs-on: uipath-ubuntu-latest | |
| name: uipath-coded-apps checker unit tests | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest | |
| - name: Run pytest | |
| run: pytest tests/tasks/uipath-coded-apps/ -v | |
| pytest-ixp-check: | |
| runs-on: uipath-ubuntu-latest | |
| name: uipath-ixp checker unit tests | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest | |
| # Pins the pre_run sweep's selection rule: it deletes projects on a shared | |
| # tenant unattended, so a regression would reap a live run's project. | |
| - name: Run pytest | |
| run: pytest tests/tasks/uipath-ixp/ -v | |
| pytest-rules-check: | |
| runs-on: uipath-ubuntu-latest | |
| name: uipath-rules checker unit tests | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest | |
| # Pins the FEEL unary-test evaluator and hit-policy logic every | |
| # uipath-rules grader uses to score the agent's decision table. | |
| - name: Run pytest | |
| run: pytest tests/tasks/uipath-rules/ -v | |
| pytest-functions-check: | |
| runs-on: uipath-ubuntu-latest | |
| name: uipath-functions checker unit tests | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest | |
| # Pins the simple-echo grader to SKILL.md rule 4: typed I/O passes | |
| # whatever the classes are named (Input/Output or EchoIn/EchoOut), and | |
| # an unannotated or dict-typed entry function fails (#4585). | |
| - name: Run pytest | |
| run: pytest tests/tasks/uipath-functions/_shared/ -v | |
| # Name kept: it is a required status check (docs/REQUIRED-CHECKS.md). Runs the uipath-planner genome checker tests | |
| # and the uipath-genome execute-check tests. | |
| pytest-genome-check: | |
| runs-on: uipath-ubuntu-latest | |
| name: uipath-genome checker unit tests | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| # check-genome.mjs is Node: the genome tests drive it through `node` | |
| - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 | |
| with: | |
| node-version: '20' | |
| - name: Install pytest | |
| run: pip install pytest | |
| # Pins the genome graders against the skills they grade: every worked example | |
| # passes the strict profile, the skill lists match skills/, and the execute | |
| # checks count a setting or an open item only where the builder puts it. The | |
| # contract tests hold the planner's templates and skill mapping to its | |
| # checker, and each skill's section pointers to its own files. | |
| - name: Run pytest | |
| run: pytest tests/tasks/uipath-genome/_shared/ tests/tasks/uipath-planner/_shared/test_genome_check.py tests/tasks/uipath-planner/_shared/test_genome_check_findings.py tests/tasks/uipath-planner/_shared/test_genome_contract.py tests/tasks/uipath-planner/_shared/test_sdd_fingerprint.py -v | |
| runtime-payload-casing-guard: | |
| runs-on: uipath-ubuntu-latest | |
| name: runtime-payload key-casing contract guard | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest | |
| # Fails if any checker reads a runtime-only debug key (finalStatus / | |
| # elementExecutions) by a hard-coded lowercase .get() instead of the | |
| # case-insensitive _get_ci accessor — the CLI #2266 PascalCase break. | |
| - name: Run contract guard | |
| run: pytest tests/scripts/test_runtime_payload_key_casing.py -v | |
| # One job for every BPMN contract guard, listed explicitly: a glob that stops | |
| # matching is a silently green job, and `-k` over the directory couples this | |
| # job to unrelated files' collection. Add new guards to the run step. | |
| bpmn-contract-guards: | |
| runs-on: uipath-ubuntu-latest | |
| name: maestro-bpmn contract guards | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest | |
| - name: Run BPMN contract guards | |
| run: pytest tests/scripts/test_bpmn_connector_request_contract.py tests/scripts/test_bpmn_doc_examples_parse.py tests/scripts/test_bpmn_project_scaffold_contract.py tests/scripts/test_bpmn_public_io_contract.py tests/scripts/test_bpmn_script_task_contract.py -v | |
| catalog-build-guards: | |
| runs-on: uipath-ubuntu-latest | |
| name: catalog build integrity guards | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest | |
| # Guards the verb-count floor / max-drop logic that stops a broken | |
| # refresh from overwriting the catalog with a base-CLI-only snapshot | |
| # (see #1203). | |
| - name: Run catalog guard tests | |
| run: pytest tests/scripts/test_catalog_build_guards.py -v | |
| cli-declaration-refresh-tests: | |
| runs-on: uipath-ubuntu-latest | |
| name: CLI declaration refresh unit tests | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest | |
| # Guards the nightly refresh-cli-declarations.yml: what counts as drift, | |
| # that a missing command writes nothing, and what the drift PR names. | |
| - name: Run declaration refresh tests | |
| run: pytest tests/scripts/test_refresh_cli_declarations.py -v | |
| skills-sh-checker-tests: | |
| runs-on: uipath-ubuntu-latest | |
| name: skills.sh grouping checker unit tests | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| # No fetch-depth override: the suite only ever resolves HEAD or a | |
| # deliberately missing ref, both of which work on the default shallow | |
| # clone. | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest | |
| # Pins the --baseline-ref contract: drift already on the base branch | |
| # warns, drift this change introduces fails, an unreadable baseline stays | |
| # strict. Without these the check regresses to failing ~20 unrelated | |
| # branches per incident (see the 2026-08-04 process-mining window). | |
| - name: Run skills.sh checker tests | |
| run: pytest tests/scripts/test_check_skills_sh.py -v | |
| sensitive-content-checker-tests: | |
| runs-on: uipath-ubuntu-latest | |
| name: sensitive-content checker unit tests | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| # No fetch-depth override: the baseline case resolves only HEAD. | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest | |
| # Replays every value the customer content-inspection gate flagged in | |
| # 1.202.0/1.203.0 (block tier must fail, inconsistent shapes must warn) | |
| # plus the false positives found tuning against main. A detector that | |
| # loosens lets a rejected shape ship; one that tightens floods PRs. | |
| - name: Run sensitive-content checker tests | |
| run: pytest tests/scripts/test_check_sensitive_content.py -v | |
| telemetry-hook-tests: | |
| runs-on: uipath-ubuntu-latest | |
| name: telemetry hook contract guard | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest | |
| # Two guards: the telemetry WRAPPER contract in hooks.json (stdin passes | |
| # through verbatim to `uip track --hook`, fail-soft exit 0, sync | |
| # SessionEnd registration — the derivation itself is guarded in the CLI | |
| # repo by track-hook.spec.ts) and the set-session-env.mjs script against | |
| # a temp CLAUDE_ENV_FILE (export line, host-wins, idempotence, | |
| # sanitization; node is preinstalled on ubuntu runners). | |
| - name: Run telemetry hook tests | |
| run: pytest tests/scripts/test_send_telemetry_hook.py tests/scripts/test_set_session_env_hook.py -v | |
| task-gate-tests: | |
| runs-on: uipath-ubuntu-latest | |
| name: task/experiment gate unit tests | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| with: | |
| fetch-depth: 0 # the regression test reads the broken hook from 80c757e03 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest pyyaml | |
| # Guards both gates in scripts/check-task-driver.py; the headline case | |
| # replays the 2026-09-04 multi-line pre_run that ERRORed the Windows split. | |
| # Also runs the behaviour tests of scripts/check-task-doc-citations.py. | |
| - name: Run task gate tests | |
| run: pytest tests/scripts/test_check_task_driver.py tests/scripts/test_check_task_doc_citations.py -v | |
| # A task prompt that cites a renamed or retired skill doc (or section) | |
| # sends the agent to a file its catalog does not ship; nothing else | |
| # re-reads tasks when a doc moves (#4531). Full-corpus scan: the corpus | |
| # is clean, so any hit is new. | |
| - name: Every skill reference a task cites exists | |
| run: python3 scripts/check-task-doc-citations.py | |
| repo-script-tests: | |
| runs-on: uipath-ubuntu-latest | |
| name: repo script checker unit tests | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest pyyaml | |
| # Unit tests for the scripts/ checkers that no domain job above covers. | |
| # The nightly SonarCloud run (.pipelines/jobs/ci.quality.sonar.yml) | |
| # measures their coverage; this job keeps them passing on every PR. | |
| - name: Run repo script tests | |
| run: pytest tests/scripts/test_build_uip_catalog.py tests/scripts/test_check_cli_verbs.py tests/scripts/test_check_connection_parity.py tests/scripts/test_check_skill_status.py tests/scripts/test_check_skill_verbs.py tests/scripts/test_check_skills_sh_findings.py tests/scripts/test_check_task_driver_edges.py tests/scripts/test_check_task_host_paths.py tests/scripts/test_parse_required_checks.py tests/scripts/test_prune_task_defaults.py tests/scripts/test_script_tests_run_in_ci.py tests/scripts/test_dockerfile_connectors_library_pin.py tests/scripts/test_task_command_patterns.py -v | |
| required-checks-contract: | |
| runs-on: uipath-ubuntu-latest | |
| name: required-check contract guard | |
| steps: | |
| - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.13' | |
| - name: Install pytest | |
| run: pip install pytest pyyaml | |
| # Pins docs/REQUIRED-CHECKS.md § Current target set to the actual job | |
| # names and triggers. Renaming a required job, or re-adding a `paths:` | |
| # filter to a workflow that produces one, stops its context from ever | |
| # reporting — which blocks every open PR until someone edits the ruleset | |
| # by hand. Nothing else in the repo reads that table, so this is the only | |
| # place the drift is visible. | |
| - name: Run required-check contract tests | |
| run: pytest tests/scripts/test_required_checks_contract.py -v |