- Docs Home
- Getting started
- XL Release
- Overview
- Installation
- Get started with XL Release
- Manage your installation
- Model your releases
- Release your software
- Release overview
- Create and start releases
- Configure release properties
- Schedule releases
- Start a release from an archived release
- Start a release from a template
- Start a release from another release
- Create a release from a Git repository
- Add a phase to a release or template
- Add a task to a phase in a release or template
- Import a release template
- Trigger releases
- Work with running releases
- Work with plugins
- Using reports
- Customize XL Release
- API and scripting overview
- Create custom task types
- Create custom configuration types
- Create custom trigger types
- Extend the XL Release GUI
- Declare custom REST endpoints
- Create custom tiles
- Create custom task types
- Create custom configuration types
- Using scheduling in scripts to connect to long running jobs
- Implement a custom failure handler
- Listen to XL Release events
- Configuration settings
- Release manuals
- XL Deploy
- Overview
- Installation
- Get started with XL Deploy
- Manage your installation
- Logging
- Start XL Deploy
- Shut down XL Deploy
- Back up XL Deploy
- Upgrade XL Deploy
- The XL Deploy repository
- Configure the repository
- Configure XL Deploy to fetch artifacts from a Maven repository
- Manage security
- Manage system settings
- XL Deploy configuration files
- Configure failover for XL Deploy
- High availability with master-worker setup
- Add, start, and use workers
- Configure active/hot-standby mode
- Configure the task execution engine
- Troubleshoot the Jackrabbit JCR repository
- Configure XL Deploy client settings
- Enable XL Deploy maintenance mode
- Update the XL Deploy digital certificate
- The XL Deploy work directory
- Reclaim disk space on an XL Deploy server
- Hide internal XL Deploy server errors
- Automatically purge packages according to a user-defined policy
- Automatically purge the task archive according to a user-defined policy
- Specify file encoding on the XL Deploy server
- Automatically archive tasks according to a user-defined policy
- Best practices for maintaining XebiaLabs tools
- Connect to your infrastructure
- Set up applications and environments
- Prepare your application for XL Deploy
- Create a deployment package
- Define application dependencies
- Configure an environment
- Using placeholders and dictionaries
- Working with deployment packages
- Preparing your application for XL Deploy
- Understanding deployables and deployeds
- XL Deploy manifest format
- Deprecated XL Deploy manifest format
- Using the XL Deploy Manifest Editor
- Understanding archives and folders in XL Deploy
- Add an externally stored artifact to a package
- Extend the external artifact storage feature
- Add a package to XL Deploy
- Export a deployment package
- XL Deploy for developers
- Tips and tricks for deployment packages
- Deploy an application
- Deployment overview
- Understanding the XL Deploy planning phase
- Steps and step lists in XL Deploy
- Understanding tasks in XL Deploy
- Deploy an application
- Use tags to configure deployments
- Preview the deployment plan
- Use orchestration
- Working with deployments
- Stopping, aborting, or canceling a deployment
- Schedule a deployment
- Update a deployed application
- Staging artifacts in XL Deploy
- Monitor and reassign deployment tasks
- Make previously deployed property values available in a PowerShell script
- Undeploy an application or deprovision an environment
- Perform canary deployments
- Perform dark launch deployments
- Perform hot deployments
- Deploying an externally stored artifact using the XL Deploy CLI
- Schedule or reschedule a task
- Using the deployment pipeline view
- Deploy to remote datacenters
- Get started with provisioning
- Introduction to the release dashboard
- Work with the CLI
- Work with plugins
- Create an XL Deploy plugin
- Base plugins and the deployed object
- Implement custom XL Deploy plugpoints
- Add a checkpoint to a custom plugin
- Step options for the Generic, PowerShell, and Python plugins
- Sample Java-based XL Deploy plugin
- XL Deploy plugin tutorial
- Standard plugins
- Middleware plugins
- Apache Tomcat
- BizTalk
- F5 BIG-IP
- GlassFish
- IBM WebSphere Application Server
- IBM WebSphere Process Server
- IBM WebSphere Liberty Profile Server
- IBM WebSphere MQ
- JBoss Application Server 5 and 6
- JBoss Application Server 7 and up
- Microsoft Internet Information Services
- Microsoft Windows
- NetScaler
- Oracle Service Bus
- Oracle Service-Oriented Architecture
- Oracle WebLogic Application Server
- Provisioning plugins
- Container platform plugins
- Tools
- Community plugins
- Using control tasks
- Using the explorer
- Using XL Deploy reports
- Customize XL Deploy
- Release manuals
- DevOps as Code
- Get started with DevOps as Code
- Install the XL CLI
- XL CLI command reference
- Work with the YAML format
- YAML snippets reference
- Manage values in DevOps as Code
- Track progress using XL CLI output
- Manage risk profiles
- Manage XL Deploy permissions in YAML
- Manage XL Release permissions in YAML
- Manage XL Release folder permissions in YAML
- Tutorial: Managing an XL Release template as code
- Blueprints
- API and CI references
- Plugins
- XL Release plugins
- XL Deploy plugins
- Standard plugins
- Middleware plugins
- Apache Tomcat
- BizTalk
- F5 BIG-IP
- GlassFish
- IBM WebSphere Application Server
- IBM WebSphere Process Server
- IBM WebSphere Liberty Profile Server
- IBM WebSphere MQ
- JBoss Application Server 5 and 6
- JBoss Application Server 7 and up
- Microsoft Internet Information Services
- Microsoft Windows
- NetScaler
- Oracle Service Bus
- Oracle Service-Oriented Architecture
- Oracle WebLogic Application Server
- Provisioning plugins
- Container platform plugins
- Tools
- Community plugins
- Videos
- Community
- Fix Trackers
- Archive
Configure SCM (Source control management) connection
As of XL Release 8.2.0, you can store template versions of templates inside a folder in a Source Control Management (SCM) tool. This provides easier management of all the artifacts, the possibility to store them together with Releasefiles and Jenkinsfiles, to configure and to use them from a release pipeline. You can define an SCM connection on a folder level or on a global level in XL Release.
Folder level configuration
To configure automatic synchronization in XL Release on a folder level:
- In the top bar, click Design.
- Click Folders.
- Select a folder.
- Click Configurations.
- Under Properties, click the plus icon next to Source Control Management.
The following options are available:
- GitHub - template changes will be pushed to the configured GitHub repository.
- BitBucket Cloud - template changes will be pushed to the configured BitBucket Cloud repository.
- GitLab - template changes will be pushed to the configured GitLab repository.
- Click Save.
The selected template changes will be pushed to the configured repository when the new version of the template is created on the Version control page.
Global level configuration
To configure an SCM connection on a global level that is available throughout XL Release:
- In the top bar, click Settings.
- Click Shared configuration.
- Under Properties, click the plus icon next to Source Control Management.
The following options are available:
- GitHub - template changes will be pushed to the configured GitHub repository.
- BitBucket Cloud - template changes will be pushed to the configured BitBucket Cloud repository.
- GitLab - template changes will be pushed to the configured GitLab repository.
- Click Save.
For more information about configuration settings shared between folders and tasks, see Create custom configuration types.
GitHub connection options
To setup a GitHub connection:
- In the Title field, enter a symbolic name for the SCM configuration.
- In the Repository full name field, enter the qualified name of the GitHub repository (
<organization_name>/<project_name>
). - In the Branch field, enter the name of the branch to which changes will be pushed. The default value is
master
. - In the Credentials section, select one of the following:
- Personal access token - Create your own personal access token in GitHub settings.
- Username and password - Provide username and password to access GitHub.
- Click Save.
BitBucket connection options
To setup a BitBucket connection:
- In the Title field, enter a symbolic name for the SCM configuration.
- In the Repository full name field, enter the qualified name of the BitBucket repository (
<organization_name>/<project_name>
). - In the Branch field, enter the name of the branch to which changes will be pushed. The default value is
master
. - In the Credentials section, select one of the following:
- API key - Provide the BitBucket team name and API key.
- Username and password - Provide the login username and password to access BitBucket.
- App password - Provide the username and app password for BitBucket.
- Click Save.
GitLab connection options
To setup a GitLab connection:
- In the Title field, enter a symbolic name for the SCM configuration.
- In the Repository full name field, enter the qualified name of the GitLab repository (
<organization_name>/<project_name>
). - In the Branch field, enter the name of the branch to which changes will be pushed. The default value is
master
. - In the Credentials section, select :
- Personal access token - Create your own personal access token in GitLab settings.
- Click Save.