Choose your adventure

There three different ways to use Git in Mage and four ways to version control your files— we’ll discussing each of them. We note that our methods for using Git are mutually exclusive.

If you’re simply looking for version control, you’re in luck! It ships out-of-the-box with Mage. That means you can always restore previous versions of your files, even if you haven’t configured any version control system. Check out this page for more info.

Methods of using Git in Mage

RecommendedUseRecommendationEase of useFunctionality
I want to see a history of my file editsMage version controlBeginnerFile-level versioning
I want to develop/deploy Mage using GitHubGitHub version controlModerateFull w/ OAuth
I want to deploy Mage using Git with any providerGit integration with Git SyncAdvancedFull w/ SSH/HTTPS Auth
⚠️I want to develop Mage using Git with any providerGit integration without Git SyncAdvancedFull w/ SSH/HTTPS Auth

Git Sync is particularly useful in production instances, where other Git methods are can be used more meaningfully in development instances. Since Git sync is a one-way sync, it’s not very useful for collaboration, since changes get overridden. However, this makes it great for a production Mage instance, where verified changes should only be accepted from development environments.

A common pattern is to use development instances to edit and push (Git integration), then have production instances use Git Sync or CI/CD.