Get started with Git
There are a number of ways to enable version control, collaboration, and easy deployment using Git in Mage. We’ll cover them all on this page.
Mage Pro
Unlock seamless version control and effortless deployments with Mage Pro! Check out this guide to experience a more intuitive, user-friendly way to manage and deploy your code.
Open source
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
| Recommended | Use | Recommendation | Ease of use | Functionality |
|---|---|---|---|---|
| ✅ | Develop/deploy Mage using GitHub | Git application | Moderate | Full w/ OAuth |
| ✅ | Deploy Mage using Git with any provider | Integration w/ Git Sync | Advanced | Full w/ SSH/HTTPS Auth |
| ⚠️ | Develop Mage using Git with any provider | Integration w/o Git Sync | Advanced | Full w/ SSH/HTTPS Auth |
Git Sync is particularly useful in production instances, where other Git methods 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.