This project serves as a template for developing a Python-based container plugin.
See How to create a new project below
⮕ Insert description here
This section describes the quickest way to get a setup with Release to test containerized plugins using the SDK Development environment. For a production setup, please refer to the documentation.
You need to have the following installed in order to develop Python-based container tasks for Release using this project:
- Python 3
- Git
- Docker
We will run Release within a local Docker environment. In the development setup, the Release server will manage containerized tasks in Docker.
Start the Release environment with the following command
cd dev-environment
docker compose up -d --build
The Release server needs to be able to find the container images of the integration you are creating. In order to do so the development setup has its own registry running inside Docker. Add the address of the registry to your local machine's hosts
file.
Unix / macOS
Add the following entry to /etc/hosts
(sudo privileges is required to edit):
127.0.0.1 container-registry
Windows
Add the following entry to C:\Windows\System32\drivers\etc\hosts
(Run as administrator permission is required to edit):
127.0.0.1 container-registry
Run the build script
Unix / macOS
sh build.sh
Windows
build.bat
This builds the zip and the container image and pushes the image to the configured registry.
There are two ways to install the plugin into Release.
Install plugin via commandline
Update the Release server details in [publisher]-release-[target]-integration/.xebialabs/config.yaml
Run the command for Unix / macOS:
sh build.sh --upload
Run the command for Windows:
build.bat --upload
The above command builds the zip and image and uploads the zip to the release server.
Install plugin via Release server UI
In the Release UI, use the Plugin Manager interface to upload the zip from build
.
The zip takes the name of the project, for example release-integration-template-python-1.0.0.zip
.
Then:
- Refresh the UI by pressing Reload in the browser.
Create a template with the task Container Example: Hello and run it!
Stop the development environment with the following command:
docker compose down
The release-integration-template-python repository is a template project.
On the main page of this repository, click Use this template button, and select Create new repository. This will create a duplicate of this project to start developing your own container-based integration.
Naming conventions
Use the following naming convention for developing Digital.ai Release integration plugins:
[publisher]-release-[target]-integration
Where publisher would be the name of your company.
For example:
acme-release-example-integration
In the new project, update project.properties
with the name of the integration plugin
cd acme-release-example-integration
Change the following line in project.properties
:
PLUGIN=acme-release-example-integration
...