How can we integrate a staging environment into the deploy flow with Source Control?

App Building
1

Hi, we're considering setting up Source Control for our apps, but I haven't seen any documentation about how to set it up to first merge to (and deploy to) a staging branch/environment.

Is that possible using Source Control in Retool?

Thanks.

1 Like
2

Hi @Evan_McDaniel! Welcome to the community. :slightly_smiling_face:

I think the first decision that you and your org needs to make is identifying where the staging environment will live. There are generally two different approaches - either spin up an entirely new instance or a new space. The latter approach works for both cloud and self-hosted instances and is typically the simpler option, especially because you can directly copy over certain configuration options.

The important thing to know is that source control for each space can be configured separately! Your production instance will be connected to and auto-deploy from main, but the other can be connected to a development or staging branch.

I hope that helps, but am happy to answer any additional questions you might have!

3

Hey Darren, thanks for the response. OK, I was hoping for something a bit lighter weight than Spaces - something that allows us to work on the same actual app, but have an intermediate step that allows for manual or automated testing prior to merging to main.

Or, perhaps I'm overestimating the work involved in setting up another Space for this purpose. Is there some existing documentation about how to setup a flow like I'm describing?

Thanks.

4

It is possible to work collaboratively on a single branch, if that is sufficient for your particular use case! You'd be able to preview and test any apps on this branch before merging into main.

That said, I do think taking the time to spin up a new Space is probably worth the time investment. It's a fairly painless process on Cloud and just a little more complicated otherwise due to the requisite DNS configuration.

image
image1076×896 57.6 KB

Once you've created the new space, all you need to do to get up and running is configure SCM and point it to a separate branch.

image
image1058×584 12.3 KB

For example, I have an instance at toula.retool.com that is pointed towards the main branch in my remote GitHub repository and a separate Space at dev.toula.retool.com that is pointed towards the dev branch in the same repository.

5

Thanks Darren. OK, so if a point the new Space at a branch that was created off of our main branch, it will end up with the same apps as what we have in our main/production environment?

If so, you are right, that is quite simple and VERY powerful. :crossed_fingers:

6

Yep! That's exactly right. :+1:

You can develop and test on one space and then all it takes to move everything to production is to merge the corresponding branch into main.

7

Excellent! I'm going to talk to my team about moving to this flow. Is there a way for us to try Source Control - can we go back after enabling it if it's not working for us?

Also, I'm assuming there are no cost implications to creating our "staging" Space. is that right?

Thanks!

1 Like
8

Glad to hear it! Let us know if you run into any challenges. :+1:

You can choose to disable Source Control at any time or even toggle it on and off for specific entities and there is no specific cost associated with defining a new Space.