Ask or search…
Comment on page

Building or Updating an Integration's Release

Step 1: Navigate to the "Integrations" Resource within the Admin Dashboard and Select the Integration you wish to Update. Once on the Integration View Page, Click Configure.

Step 2: Within the Configuration Settings, Navigate to the Repository Settings and Confirm their Accuracy

Repo Settings
  • Repository URL: A link to the repository Bitbucket, Azure, or Github.
  • Repository Tracking Branch: You can tell us the branch to track for releases. Every time we see this branched pushed we will create a new Release.
  • Repository Path: Path to PANDIUM.yaml relative to the root of the repository. If left blank, we will look for the file in the root.
Note: You will next see the section for 'Default Release', where you configure the behavior for instances of the integration installed via your marketplace. If you have already set up and built releases via source control they will show up here, if not, continue on to Step 3 and you will be able to come back and edit the behavior at any time once a release is built.

Step 3: Build the Release from the Integration Page

Example integration showing the 'Build Release' button
These steps assume you have already setup your Source Control and connected to your repository. If you have not, learn more about setting that process up here.
On the integration page, you’ll have the ability to automatically populate your repository with the folder structure and relevant files to build your integration.
Click the ‘Setup Integration Repo’ button, which will start that process. This will then take you back to the Source Control page, where you can view the build starting in the Activity section. Once this completes, you'll be connected to Source Control, ready to create your first tenant, and have a release ready to apply to it.
Alternatively, you can manually build a new release two different ways: via the Source Control tab in ‘Settings’, and selecting it from the integration selection dropdown below the repository connection options, and naming your release via a tag. Then, you can build a new release.
The other option is by clicking the ‘Build Release’ button on the main integration detail page. Source control will kick off, and look for the designated URL path and repository information set in your integration configuration, and will build a new release based on changes in the code base. This sync can be set to run on a schedule but many prefer to run it manually as needed.

Step 5: Set the Default Release (optional)

Upon navigating back to your selected integration's configuration page where you set your repository settings, you will see a "Default Release" section. The default release will be the version of the integration that your customers will automatically be provisioned upon installing the integration from your marketplace. There must be a default release selected for your customers to install the integration. To select a release from the dropdown, you have to have built one or more release versions via source control.
There are three separate options for the default release behavior:
  1. 1.
    Static Default - Installed tenants use currently set default integration release. Release does not change on the tenant unless reset manually in the administrator platform.
  2. 2.
    Installed tenants will be created using currently set default integration release. If the integration default release changes, the installed tenants will change their release(s) to match on the next sync.
  3. 3.
    Tenants will always use the most recently-built release available for this integration.
Last modified 12d ago