Leapwork Performance CI/CD Examples
===================================

This bundle contains sample files for integrating Leapwork Performance into CI/CD pipelines.

Contents
--------
- azure-devops/azure-pipelines.yml
- azure-devops/run-integration.ps1
- azure-devops/poll-integration-status.ps1
- jenkins/windows/Jenkinsfile
- jenkins/windows/run-integration.ps1
- jenkins/windows/poll-integration-status.ps1
- jenkins/linux/Jenkinsfile
- jenkins/linux/run-integration.ps1
- jenkins/linux/poll-integration-status.ps1

What these samples do
---------------------
1. Start a Leapwork Performance integration run.
2. Save the returned identifiers needed for polling.
3. Poll until the run reaches a terminal status.
4. Download the Excel report and AI analysis report when available.
5. Fail the pipeline if the final status is not Finished.

Required secrets and variables
------------------------------
- LEAPWORK_PERFORMANCE_BASE_URL
- LEAPWORK_PERFORMANCE_API_KEY
- LEAPWORK_PERFORMANCE_TIMELINE_ID or a combination of timeline name and project id
- LEAPWORK_PERFORMANCE_PROJECT_ID when using timeline name
- LEAPWORK_PERFORMANCE_DATA_ITEM_ASSET_ID or LEAPWORK_PERFORMANCE_DATA_ITEM_NAME
- LEAPWORK_PERFORMANCE_ROLE
- LEAPWORK_PERFORMANCE_USER_COUNT

API endpoints used
------------------
- POST /api/integration/runIntegration
- GET  <pollResultUrl>
- GET  /api/integration/stopIntegration?runId=<runId>

Notes
-----
- Replace placeholder values before sharing with customers.
- The PowerShell examples are written for Windows agents and for Linux agents that have PowerShell 7 installed as `pwsh`.
- The scripts write run metadata to run-output.json and download reports into a reports folder under the current workspace.