Skip to main content

Change control and story versioning

Safely experiment with ideas for improvements with change control

Written by Jamie Gaynor
Updated today

By default, whenever you update a story in Tines, your changes are applied and live instantly. This works great for simpler use cases, and especially for building out v1 of your workflow.

For up-and-running, mission-critical workflows, however, it's important to have greater oversight of changes. You need to be able to safely experiment with ideas for improvements, and apply a complicated change-set in either one complete update or multiple at a time. That’s where change control comes in.

Enabling change control

For any story, enable change control with the toggle in the upper right corner.

Tenant owners have the choice to enable change control by default for all stories in a team or tenant, while only team admins or those with custom change control permissions can enable change control within a story.

Once, enabled, you’ll now have two working spaces and executional environments for your story – Test and Live.

Users can create drafts where they can freely make changes and test those changes within their draft without impacting the live, running story.

Multiple builders can collaborate on a draft, while at the same time, multiple drafts can be created in one story. Multiple drafts are helpful in a few ways:

  • Team members can work in parallel, testing different approaches to solve the same problem

  • Small changes can be pushed live while working on larger modifications to a story

Testing changes

NOTE: With change control enabled, it's not possible to directly edit the Live environment. Instead, you make your changes in Test, and – once you’re ready and it’s safe to do so – push them en masse to Live.

You can build inside a draft as you normally would in Tines. When testing different ideas, it may be more helpful to send external data to a test version of your webhook, page, or email action by using the unique URL in the draft story. You can also use live events in draft mode.

Using different resources and credentials in the Test environment

Depending on your workflow development style, you may want to target independent test versions of some or all external services.

This can be achieved by using our META.story.is_test variable, and an IF function inside your action configuration. For example, to target your development Jira instance in Test, and your production instance in Live, you could use an expression like:

IF(META.story.is_test, CREDENTIAL.jira_test, CREDENTIAL.jira)

View changes

When you are finished with updating your draft and you are ready to set your changes live, click the View changes button. The view changes modal will pop up for you to review and compare your edits to the live version.

This modal can be detached and opened in a separate window to help you review complex changes in a wider screen.

Approving and pushing changes live

All changes must be reviewed and approved before being pushed to Live. Once you’re satisfied that your test changes are complete and validated, you can Request a review. (Alternatively, you can reset to the live version if your changes aren’t working out.)

Once a review is requested, a notification is sent within the Tines UI and to the change control webhook, if configured. Change requests can be approved by an Editor, Team Admin, or a user with custom permissions.

After pushing, your changes will be applied together in a single update. Any in-flight story runs will immediately switch over to the new logic, consistent with how edits to non-change-controlled stories are applied.

For stories with multiple drafts, those drafts will be marked as out of date and synced with the latest live version. Though not as common, should there be any merge conflicts a modal will pop up to help you resolve those conflicts.

Tips and tricks for change control

Enabling change control for your critical stories can be extremely helpful, especially when you can use it to its full potential. We've pulled together some tips on making the most of reviewing and collaborating on changes for your workflows.

Feature

Description

Set-Up

Have a standard agreement on what makes a workflow mission-critical and worthy of change control.

Tenant owners should define tenant-wide change control settings based on their judgment and processes.

Set up change control webhooks to receive all change control notifications for your team.

  • Customize notifications to align with your team's processes, whether that's notifying certain people in Slack or Teams, and/or storing change control activity in a longer-term data storage product.

Building

For drafts with more complex edits, duplicate your draft and push the smaller changes live to keep a story moving along

Testing

Use multiple drafts to make collaboration easier and let various users test out their own ideas

Review

Make sure the changes you are making align with the purpose of your workflow for a more efficient review process.

  • Make descriptions and change names a requirement to properly document changes and maintain a standard across story building

  • Reviewers should understand the purpose of your workflow - descriptions will help with this!

  • Allow more builders to help with the review process with custom permissions

  • To prevent any single user from both requesting and approving their own changes, activate approval requirements for all updates.

  • Push approved changes promptly to maintain version control

To learn more about change control, read the docs here.

Using story versioning

Please note: Story versioning is available on Tines paid plans only.

You can access version history by clicking the dropdown menu next to the story name. You can rename, delete, clone, or export stories here.

Preview

To preview a previous version of a story, select from the versions available and select the preview option.

Preview allows for a review of the overall story and inspection of specific changes. This can be helpful if you wish to review or recreate a specific action's configuration after you make a change.

Revert to a previous version of a story

To access previous versions of your story, click on the three dots on the top right of your story and select Versions. You can then select a previous version of a story.

From here, you can view the changes made from the previous version and decide whether to restore them or not.

How long are story versions retained?

Story versions are retained indefinitely unless the story is deleted from the tenant.

To learn more about story versioning, see here.

Did this answer your question?