Deploying what you built with Build Agent
Summarize
Summary of Deploying what you built with Build Agent
This guide explains how to deploy applications developed with Build Agent within the ServiceNow platform, focusing on workflows, deployment methods, and tools that ensure a smooth transition from development to production. It highlights how you can safely iterate on app changes without impacting live environments and choose deployment strategies that fit your application complexity and organizational needs.
Show less
Deployment Workflow
- Collaborative design: Business and IT teams align on requirements using familiar tools.
- AI-driven development: Build Agent and Now Assist generate app updates from files, chat histories, and diagrams.
- Review and testing: Teams preview, revise, and test performance and readiness of updates.
- Developer review: Developers verify AI-generated changes and confirm readiness for deployment.
- Deployment approval: Deployment managers initiate approval workflows.
- Autonomous checks: AI agents scan for issues such as sensitive data exposure and remediate automatically.
- Final deployment: Approved changes are deployed securely.
Important: Changes remain isolated until explicitly deployed, preventing interference with live applications. Isolation mechanisms vary between ServiceNow IDE (source/build artifacts) and ServiceNow Studio (update sets).
Deployment Methods
- Git-based source control integration: Supports CI/CD workflows through Git repositories (e.g., GitHub, Bitbucket) integrated with ServiceNow IDE, enabling branching, merging, and automated deployments.
- Update sets and application packaging: Uses System Update Sets to track and transport changes. Scoped apps can be packaged into applications via Application Repository (AppRepo) for easier cross-instance deployment.
Options for Moving Apps Across Instances
- Wrap scoped applications in update sets, convert to AppRepo, publish with demo data, and deploy through ReleaseOps or standard update set processes.
- Publish scoped apps directly to AppRepo using Git or update sets, enabling distribution across environments and integration with ReleaseOps pipelines that automatically run Automated Test Framework (ATF) tests.
- Register and entitle apps before publishing to comply with governance and distribution requirements.
Additional Deployment Tools
- App Engine Management Center (AEMC): Performs governance validations (ACLs, roles, compliance) and provides dashboards for version and deployment monitoring.
- ReleaseOps: Facilitates multi-instance deployments using customizable playbooks, automates validation and approvals, executes ATF tests, and supports scheduled or immediate releases.
- ServiceNow SDK: Enables moving applications between local environments and ServiceNow instances, integrating with external CI/CD pipelines via CLI authentication and commands.
- Automated Test Framework (ATF): Generates and runs tests to verify app functionality post-deployment within ServiceNow Studio or IDE.
Important Considerations
Deployment paths using Application Repository and update sets are mutually exclusive per application and instance. Once deployed via one method, switching to the other is not supported. However, global applications can be included in both source control and AppRepo.
Learn about deployment methods and workflows for moving applications created with Build Agent from development to production environments. Choose the right deployment approach based on your application complexity and organizational requirements.
Workflow for deployment
- Collaborative design: Business owners and IT collaborate on requirements and ideas using their preferred tools.
- AI-driven app development: Build Agent and Now Assist process files, chat history, and diagrams to generate and implement app updates.
- Review and testing: Teams preview updates, make revisions, and run rounds of performance and readiness testing.
- Developer review: A developer reviews the AI-generated changes, compares versions, and confirms the changes are ready for deployment.
- Deployment approval: The project is handed off to a deployment manager, who initiates the deployment approval process.
- Autonomous checks: AI agents automatically scan for issues (such as sensitive data exposure or model integrity problems) and remediate them before deployment.
- Final deployment: After all readiness scans and approvals, the new app is deployed securely and efficiently.
- In the ServiceNow IDE, isolation runs through source and build artifacts until you deploy and install.
- In ServiceNow Studio, changes are tracked in update sets and promoted when you move the update set between instances.
Deployment methods for Build Agent
- Git-based source control integration with ServiceNow IDE: ServiceNow supports Git-based workflows for version control and CI/CD.
- You can push scoped apps to Git repositories, enabling branching, merging, and automated deployments. ServiceNow IDE supports bring-your-own Git integration, such as GitHub or Bitbucket.
- For more information, see Integrating source control with the ServiceNow IDE.
- Update sets and application packaging: Standard ServiceNow deployment uses System Update Sets to track changes.
- Advanced guidance includes packing update sets into scoped applications for easier transport and installation across instances, for example using Application Repository (AppRepo).
- For more information on System Update Sets, see System update sets.
Options for moving apps through instances
- Wrap the entire scoped application in an update set. The workflow is as follows:
- Go to the Custom Applications list, select an app and swap to its scope.
- Convert the app to AppRepo.
- Publish the update set with demo data.
- Put the update set in a deployment request for ReleaseOps, or follow your standard update set process for deployment.
- Publish the app to AppRepo:
- You can use a Git-based process or update sets to publish to AppRepo.
- Scoped apps, as well as apps that are ready for testing, can be published to the AppRepo for distribution across environments.
- After an app is in AppRepo, you can move it through a ReleaseOps pipeline. If ATF tests are included in the pipeline, they automatically run.
- Register and entitle apps before publishing.
- For more information on Application Repository, see ServiceNow application repository.
Additional deployment tools
- App Engine Management Center (AEMC):
- After developing an app, submit it to AEMC for governance checks.
- AEMC validates ACLs, roles, and compliance settings before deployment.
- Use ReleaseOps pipelines to move apps through environments with ATF tests and approval gates.
- AEMC provides dashboards for monitoring deployments and managing app versions throughout the lifecycle.
- For more information on AEMC, see Using the App Engine Management Center.
- ReleaseOps:
- Move changes from development to production through multiple instances using customizable playbooks.
- Automate preview, commit, and validation of update sets before deployment.
- Run Automated Test Framework (ATF) tests as part of the pipeline to validate quality.
- Deploy changes immediately or schedule releases for controlled rollouts.
- Enforce checks, scans, and approvals before production deployment.
- For more information on ReleaseOps, see ReleaseOps.
- ServiceNow SDK:
- Use the ServiceNow SDK to move applications to and from your instance to your local machine. You can integrate the ServiceNow SDK with your off-instance CI/CD process if you have one.
- Install the ServiceNow SDK locally and use the command line interface (CLI).
- Authenticate to a ServiceNow instance from the ServiceNow SDK.
- Push to or install an application on the authenticated instance from your local environment.
- Automated Test Framework (ATF)
- Tests can be generated by Build Agent and executed in ServiceNow Studio or ServiceNow IDE to confirm functionality after changes.
- For more information on ATF, see Automated Test Framework (ATF).
Mixing application repository and update set deployment
For more information, see the Can't mix Update Set and App Repo deployment for the same application [KB0715422] article in the Knowledge Base.