Docs about Docs logo Docs about Docs

This checklist is used when a new version of an existing SaaS integration is slated for release. Note: This may not be the full list of tasks required to release an integration version. Refer to the documentation task in JIRA for the full list.

Items marked as REQUIRED must be completed prior to release.

Required Description
REQUIRED

Add new version data

Add the new version’s data to the integration’s version file. In this step, you’ll add the new version and deprecate the previous one.

REQUIRED

Update base documentation

Create a new version of the integration’s documentation, and then update it to reflect any changes made as part of the new version.

REQUIRED

Verify Connect source form properties

Verify the attributes for the integration’s corresponding Connect source form property. These attributes may change from version to version, so it’s important to check for changes after a major version bump.

REQUIRED

Update the permalink and the input parameter

Update the permalink and the input parameter for each version.

OPTIONAL

Update integration schema files

If there are changes to the integration’s schema, you’ll need to update the schema files to reflect the changes.

OPTIONAL

Update SaaS foreign keys

If there are changes to the integration’s foreign keys, you’ll need to update the foreign key file to reflect the changes.


Back to top

Last updated: 15 October 2024