TLDR

This article guides you through the deployments and version control applications in Mage Pro. Both applications simplify how data engineers perform CICD. It explains how to connect Mage Pro to GitHub, use version control features to manage code changes, and configure deployment stages. The platform streamlines the entire workflow from repository setup to deployment, eliminating manual processes and ensuring consistent versioning across environments.

Table of contents

• Introduction

• Step 1: Introduction to Mage Pro features

• Step 2: Connecting Mage Pro to Github

• Step 3: Setting up your Github Organization

• Step 4: Selecting your repository

• Step 5: Configuring deployment stages

• Step 6: Navigating the version control application

• Step 7: Connecting to Git Origin

• Step 8: Committing your changes

• Step 9: Creating and merging a pull request

• Step 10: Deploying your code changes

• Conclusion

Introduction

Data projects shouldn't be derailed by manual or clunky processes to deploy code. Mage Pro simplifies this process through its deployment and version control applications. This guide walks you through Mage Pro's powerful GitHub integration, intuitive deployment stages, and version control features that transform messy manual processes into a user friendly workflow. Are you ready to reclaim the time you've been losing to deployment inconsistencies? Let's explore how Mage Pro can help make your CICD workflows more efficient.

Step 1: Introduction to version control features

Mage Pro has features that are designed to streamline data engineering processes. CICD is no different. With its user-friendly interface and powerful features, it helps you manage your data projects with ease. Whether you’re a seasoned developer or just starting out, Mage Pro simplifies CICD tasks, allowing you to focus on what really matters: building pipelines that will have an impact on your business.

Key CICD features in Mage Pro:

• GitHub integration: Connect your Mage Pro application directly to GitHub for effortless code management.

• Easy deployment stages: Define multiple deployment stages to manage your environments effectively.

• Version control: Keep track of your code changes and maintain a clean history of your deployments.

Step 2: Connecting Mage Pro to GitHub

Connecting Mage Pro to GitHub is a straightforward process that sets the foundation for effective version control. Follow these steps to establish a connection:

Navigate to the deployments application

1. From the home page hover over the left popout navigation menu and click “Deploy”

2. Next you will be taken to your deployment configurations page, click the blue “Open deployment settings” button.

3. From the Deployments page click the “Set up connection” button.

How to connect

1. Once you are on the Deployments screen you will have a project directory already set up.

2. Press the purple “Connect” button to initiate the GitHub connection process.

3. Authenticate your GitHub account using token authentication. If it’s your first time, you’ll be prompted to sign in and grant permissions.

4. Once authenticated, you will be redirected back to the Mage Pro connection page.

   

Step 3: Setting up your organization

After connecting to GitHub, the next step is to set up your organization. This allows you to manage repositories under a specific account.

Steps to set up your organization

1. Select your organization from the dropdown menu.

2. If none appears, manually enter your organization name in the text box, and then click the “Set Organization” button to confirm your choice.

3. If you’re connecting to a private repository, ensure you install the Mage Pro app on GitHub for proper access by clicking the purple “Install Mage Pro app on Github” button.

4. Again, you will be prompted to authenticate with GitHub and then will navigate back to the Deployments page.

   

Step 4: Selecting your repository

The next step in the process is to choose your repository and set the primary branch that your production code will mirror. To do this complete the following steps:

Repository selection process

1. On the Connect repository page, look for the repository selection option.

2. Select the desired repository from the dropdown list. If necessary, create a new one in GitHub.

3. Choose your production branch from the dropdown menu. If branches are not populating, manually enter the branch name (e.g., main) and hit the “Set Branch” button.

   

Step 5: Configuring deployment stages

Once your repository is selected, it’s time to configure deployment stages. This is where you define the environments for your application.

How to configure deployment stages

1. Navigate to the Deployment stages page by clicking the “Next step to Deployment stages” button.

2. Click on the “Add stage” button.

3. Define your environment name (e.g., Development). This helps you organize your deployments.

4. Select the branch for this stage from the dropdown menu, and if none are available type the branch into the text box and click “Set branch”

5. Specify your target directory, which will be where your project files are stored.

   

Step 6: Navigating the Version Control application

Now that you’re connected and have set up your repository, it’s time to tackle the Version Control application. This is where you’ll manage your branches, commits, and overall code history.

Understanding the interface

The Version Control application is terminal already connected to Git. You can run your Git commands in this terminal at the bottom of the page. The returns will populate above the space dedicated for writing commands.

Key Commands to Remember

• git branch: Check your current branch status.

• git log: View your commit history.

• Git checkout: Switch to a new branch

• git status: See untracked files and changes ready to be committed.

• Git add: Add your code files for commit

• Git commit: Commit your code files

• Git push: Push code files to your GitHub repo

Familiarize yourself with these commands, as they will become second nature as you navigate through your projects.

Step 7: Connecting to Git Origin

Once you're comfortable with the Version Control application, the next step is to connect to your Git origin. This connection is essential for pushing your changes to GitHub.

How to connect to Git Origin

1. Open the Version Control application.

2. Run the command git remote -v to check your current remote connections.

3. If there’s no origin listed, use the command git remote add origin [your-repo-url] to establish a connection.

4. Verify the connection again by running git remote -v.

Once connected, you’re ready to push your changes to GitHub!

Step 8: Committing your changes

The next part in the Version Control process is committing the code changes you made in your files. This is how you save your progress and document your work.

Steps to commit changes

1. After making changes to your files, run git status to see the modified files.

2. Use git add [file-name] to stage specific files, or git add . to stage all changes.

3. Commit your changes with git commit -m "your commit message". Make sure your message is clear and descriptive.

Regular commits help keep your project organized and make it easier to track changes over time.

Step 9: Creating and merging a pull request

Now that you’ve committed your changes, it’s time to create a pull request (PR). This is an essential step for collaboration and code review.

How to create a pull request

1. Push your branch to GitHub using git push origin [branch-name].

2. Navigate to your GitHub repository in the browser and click the “Compare and Pull Request” button.

3. You will be taken to the Open Pull Request page, click the “Create Pull Request” button.

4. As long as there are no conflicts, you can click the green “Merge Pull Request” button.

5. Finally, click the “Confirm Merge” button and then head back to Mage Pro.

   

Step 10: Deploying your code changes

After your pull request has been merged, it’s time to deploy your code changes. This step makes your updates live in your cluster.

Deployment Process

1. Return to the Mage Pro deployment application.

2. Locate your latest deployment under the Deployments section.

3. Click the Deploy button next to the version you want to go live with.

4. Wait a few moments as Mage Pro handles the deployment process.

Once the deployment is successful, you’ll see a confirmation message. Your new version is now live!

With these steps, you’re well-equipped to handle deployments and version control effectively within Mage Pro. Embrace the simplicity and efficiency of this workflow, and watch your productivity soar!

Conclusion

Mage Pro takes the headache out of deployments and version control for data teams. It connects easily with GitHub, making code management simpler and more reliable. By replacing messy manual processes with clear steps from repository setup to deployment, teams can spend more time building useful pipelines. Whether you're experienced or just starting out, Mage Pro helps you manage your work better. Try it and watch your team get more done with less frustration.

Want a free demo session of Mage Pro? Click here to book yours today.