2. Getting your Repository Ready

There are two currently supported ways to get your copy of Flyway AutoPilot. If you wish to use GitHub and it's Actions deployment pipelines, follow the first guide on using the template repository. If you wish to use Azure DevOps, skip to the next step and import the repository into a ADO Project!

IMPORTANT: These Repositorys will be potentially holding schema backups! Under no-circumstance do we recommend making these public facing! Follow all steps and make sure to keep them private, with access only to people authorised!

Getting started with GitHub

  • The entire project, and all needed files/scripts are located inside one easy-to-copy GitHub repository. Go to the Flyway AutoPilot for SQL Server repository and click Use This Template. This means that you have your own copy, all of the files you need to get started, as well as your own GitHub Actions Pipeline. Steps may vary slightly, depending on the choice of DBMS, but this should be clear!

  **Important:** Do not fork the repository. Instead, create a private repository using it as a template. This keeps it secure and away from the public eye!

  • Give this repository an easily accessible name and set it to Private, allowing you to potentially move your own schema into it without it being public! Then click Create Repository.
  • Click on the green **Code** button and under the HTTPS submenu copy the URL. You’ll need this to create a new project from version control in Flyway Desktop.


Getting started with Azure DevOps (Instead of GitHub)

  • create a new Azure DevOps Project

  • Head to Repository > Import Repository > Use the main GitHub repo link ( https://github.com/red-gate/Flyway-AutoPilot-AB )

  • Your new Repository should look similar to this. If so, copy the main URL and move onto the step where we will clone it down into Flyway Desktop below!


Cloning GitHub or ADO Repository into Flyway Desktop

Tip: You should only have done one of the set of steps above, creating either an Azure OR GitHub Repository! 
Remeber: These Repositorys should be Private

 

  • Click the **Open project…** drop down > Open from version control. Paste the copied URL, select an empty folder as the directory, and click **Clone**.

  • Select the `flyway.toml` file and click **Open**. In newer versions of Flyway Desktop, it will find your toml file automatically, so this may not be needed!


  • You will get an error about your database connection. This is because we haven’t created them yet. Click on the blue folder icon in the upper right to jump to the files on disk so we can create the necessary databases.


    Once you have followed these steps you will have successfully created your own repository, with a Flyway Project inside, linked to your local installation of Flyway Desktop! We know want to make sure we have the appropriate environments available, see how Flyway AutoPilot can assist in the next set of steps!


    Remeber: If you need a trial key for Flyway Enterprise, you're in luck! You can easily get a free trial to explore the full range of features, onboard your team, or understand our offerings better via Flyway AutoPilot. Simply visit here to start your free trial today. If you have a contact at Redgate, you can also request a trial key for Flyway AutoPilot directly from them. Alternatively, you can reach out to the AutoPilot team at flywayap@red-gate.com for a license.


Didn't find what you were looking for?