Using a declarative or scripted pipeline in DevOps
-
- UpdatedJan 30, 2025
- 3 minutes to read
- Yokohama
- DevOps
When you use a Jenkinsfile, steps are created, mapped, and associated to orchestration tasks automatically instead of manually.
Jenkinsfile is a text file that contains the definition of a Jenkins pipeline and is checked into source control.
Each root-level stage configured in the Jenkinsfile is discovered as a separate orchestration task in DevOps that is mapped to an individual step.
DevOps Jenkinsfile commands
- snDevOpsChange(ignoreErrors:{true/false},changeRequestDetails:{setCloseCode:{true/false},attributes:})
Where ignoreErrors specifies the setting to prevent job failure if there is an error (true/false)
Where changeRequestDetails specifies closure code and change request fields from within the pipeline
Enables change control for each root-level stage that is mapped to a DevOps step.
- snDevOpsArtifact
Registers artifacts when configuring Artifacts and packages.
- snDevOpsPackage
Creates a package for artifacts when configuring Artifacts and packages.
- snDevOpsGetChangeNumber
Retrieves the change request number in a Jenkins pipeline based on specific change details.
- snDevOpsUpdateChangeInfo
Updates the change request details associated with a Jenkins pipeline.
- snDevOpsSecurityResult
Configures security scans on any stage of the pipeline and the scan details are retrieved from the corresponding stage to DevOps Change Velocity.
You can specify the Jenkins server configuration in any of these steps by passing the configurationName attribute in your pipeline. If the configuration name is not specified in any step, the default configuration will be used in that step. Passing an incorrect configuration name will result in the step to fail unless the Ignore ServiceNow DevOps errors option is selected while configuring the Jenkins plugin.
Jenkins snippet generator for DevOps
- SnDevOpsArtifact
- SnDevOpsChange
- SnDevOpsPackage
- snDevOpsGetChangeNumber
- snDevOpsUpdateChangeInfo
- snDevOpsSecurityResult
Parallel and sub-stage support
When a stage (or set of parallel stages) is nested within a pipeline stage, these rules apply:
- Any action from the nested stage is processed as part of the parent root-level stage
- Only one change request is created (at the parent root level) even if multiple stages nested under the parent root-level stage trigger a change
- Orchestration tasks created are always associated with the parent root-level stage (not the nested stage)
Example: Sub stage
In this sub-stage example, if a change request gets created from the sub stage (deploy PROD), the details of the parent root-level stage (deploy) are used in the change request, and orchestration tasks are also associated with the parent root-level stage (deploy).
Example: Parallel stage
In this parallel stage example, if a change request is created from a sub stage (UAT test-1 and/or UAT static code test), only the first change request is created (using the details of the parent root-level stage, UAT test) regardless of whether both sub stages (UAT test-1 and UAT static code test) get triggered.
There is no indication of which parallel stage generated the change, and orchestration tasks are associated with the parent root-level stage (UAT test).