Import based evidence collection
Summarize
Summary of Import based evidence collection
The Import based evidence collection feature optimizes change management and evidence collection for GitHub Actions and Azure DevOps (ADO) by reducing instance overhead. It achieves this by skipping step-level pipeline event processing, instead attaching all relevant evidence to the change request via import requests rather than webhook notifications. This results in faster and more efficient evidence gathering during pipeline executions.
Show less
Enabling and Using the Feature
- Enable the feature by toggling on Import based evidence collection for orchestration capability in the Properties page under DevOps Change Velocity properties.
- When enabled, the system skips step-level event processing, which decreases load and speeds up processing.
- Disabling the toggle reverts to processing all inbound pipeline events as usual.
- Important: Do not switch the toggle during active pipeline runs to avoid pipeline hangs or timeouts. Cancel any active change requests before toggling.
- After enabling, save the setting and initiate a new pipeline execution to apply changes properly.
Evidence Collection Process
When a change step triggers in a pipeline, an import request is created to collect pipeline execution details and evidence. This evidence is attached to the change request. The import based collection is triggered again at pipeline completion to ensure all evidence is captured accurately. Auto-approval and subsequent workflows continue as per existing behavior.
Behavior by Platform
- Azure DevOps (ADO):
- Build pipelines collect evidence only on pipeline completion when the feature is enabled.
- Release pipelines still process step-level events even if enabled.
- GitHub Actions:
- Evidence collection happens on workflow completion only, skipping step-level events.
- If GitHub Actions Deployment Gates are used, configure the GitHub app accordingly; evidence collection remains based on workflow completion.
- Environment-based change is not supported with this feature enabled.
Key Points for ServiceNow Customers
- The feature supports all pipeline styles (reruns, parallel, sequential) and configurations for GitHub Actions and ADO.
- All existing evidence types supported for GitHub Actions and ADO continue to be supported when this feature is enabled.
- Historical import and polling behaviors are unaffected by the toggle setting.
- Import request records can be restarted as needed without disruption.
- Troubleshooting and error handling remain consistent regardless of the feature state.
- Upon upgrading, this capability is off by default and must be enabled explicitly.
Reduce instance overhead by skipping step-level pipeline processing for accelerated change management and evidence collection for GitHub Actions and Azure DevOps (ADO) orchestration tools.
All relevant evidence in the pipeline is attached to the change request using import request instead of webhook notifications.
Enable import based evidence collection
You can enable this feature by switching on the Import based evidence collection for orchestration capability toggle in the Properties page. For more information, see DevOps Change Velocity properties.
How is the evidence collected
When the change step in a pipeline is triggered, a callback record is created with the state: created and change evidence status: pending. An import request, with the corresponding import request pages are created to gather pipeline execution details and the required evidence. The change request is then created with all the evidence attached to it. In addition, the import based evidence collection feature is triggered again at the pipeline completion event to ensure all the associated evidence is accurately retrieved and associated with the change request. Post-creation of the change request, the auto-approval mechanisms, and subsequent behaviors remains the same as the existing behavior.
- For ADO
-
- For build pipeline, when the property is enabled, the evidence collection happens based on the pipeline completion event only (step level events aren’t processed to reduce the instance overhead).
- For release pipeline, even if the property is enabled, the evidence collection happens based on processing step-level events.
- For GitHub Actions
-
- When the property is enabled, the evidence collection happens based on the workflow completion event only (step level events aren’t processed to reduce the instance overhead).
- If you’re using GitHub Actions Deployment Gates in any of your steps, then you must configure the GitHub app, and the evidence collection happens based on the workflow completion event. For more information on deployment gates, see GitHub Deployment Gates for ServiceNow DevOps Change.
Key points
- Import based evidence collection supports all existing pipeline styles (reruns, parallel, sequential) and configurations for GitHub Actions and ADO.
- All types of evidence collection supported for GitHub Actions and ADO in the base system are also supported when this property is enabled.
- For GitHub Actions, environment-based change isn’t supported.
- Historical import and polling features works the same way regardless of the Import based evidence collection for orchestration capability property being enabled or turned off.
- Restarting import in the import request record is also supported.
- Troubleshooting and error handling frameworks remain unaffected.
- If you’re upgrading, the Import based evidence collection for orchestration capability property is turned off by default.