How to Use GitHub with Android Studio

To use GitHub with Android Studio, clone a GitHub repository, create or switch branches, commit changes locally, and push them to a remote repository. Android Studio includes built-in Git integration, allowing you to perform common version control tasks directly from the IDE.

Prerequisites

Before starting, make sure you have:

• Android Studio installed
• A GitHub account
• Access to the GitHub repository you want to work with
• Git installed on your computer (Android Studio uses your local Git installation and usually detects it automatically).
• GitHub authentication configured if you plan to push changes (GitHub no longer accepts password authentication for Git operations).

Git and GitHub Terms to Know

Before working with GitHub in Android Studio, it helps to understand a few basic Git concepts:

Branch — An independent line of development that lets you make changes without directly affecting another branch.

Commit — A saved snapshot of changes in your local Git repository, including information such as the author, timestamp, and commit message.

Repository — The collection of project files and their version history managed by Git.

Local repository — The copy of a Git repository stored on your computer.

Remote repository — A version of the repository hosted remotely, such as on GitHub, that developers can use to share and synchronize changes.

---

Clone a GitHub Repository in Android Studio

To start working with an existing GitHub project, clone the repository to your local computer using Android Studio.

Open Android Studio and select Clone Repository.

Next, open the GitHub repository you want to clone.

Select Code, make sure HTTPS is selected, and copy the repository URL.

Return to Android Studio:

1. Paste the repository URL into the URL field.
2. Choose the local directory where you want to save the repository.
3. Select Clone.

 

Android Studio will clone the repository to your computer and open the project.

Example: Clone the QuickBlox Android SDK Repository

If you’d like to follow along, you can clone the QuickBlox Android SDK repository to explore Android chat and video calling samples and see how QuickBlox functionality is implemented in a real Android project.

---

Create a New Git Branch

A Git branch lets you work on changes independently without directly modifying another branch.

To create a branch in Android Studio:

1. Open the Git menu.
2. Select Branches.

 

The Branches window displays the available local and remote branches.

Select New Branch.

Then:

1. Enter a name for your new branch.
2. Select Create.

 

If Checkout branch is selected, Android Studio will switch to the new branch after creating it.

---

Switch Between Git Branches

To switch to another Git branch in Android Studio:

1. Open Git.
2. Select Branches.

 

Select the branch you want to work with and choose Checkout.

Android Studio will switch your working directory to the selected branch.

---

Commit Changes in Android Studio

A Git commit saves a snapshot of selected changes to your local Git repository. A commit only updates your local repository. To share your changes with other developers, you’ll need to push the commit to the remote repository on GitHub.

After making changes to your project:

1. Open the Commit tool window.
2. Select the files you want to include.
3. Enter a clear commit message describing your changes.
4. Select Commit.

 

Your changes are now committed to your local Git branch.

---

Push Commits to GitHub

Pushing sends committed changes from your local Git branch to its remote repository.

After committing your changes:

1. Open the branch/Git menu.
2. Select Push.

 

Review the commits that will be pushed, then select Push.

Your commits will be sent to the corresponding remote repository and branch. If you’re pushing a newly created branch for the first time, Android Studio automatically creates the corresponding remote branch on GitHub before uploading your commits.

---

Pull Changes from a Remote Repository

When other developers push changes to a remote repository, you can use Pull to download the latest changes and update your local branch.

To pull the latest changes in Android Studio:

1. Open the Git menu.
2. Select Pull.
3. In the Pull dialog, choose the remote repository and branch.
4. Select Pull.

 

If prompted, choose how Android Studio should integrate the incoming changes. For example, you may choose to:

• Merge the incoming changes into your current branch.
• Rebase your current branch onto the incoming changes.

Select the appropriate update method for your Git workflow, then click OK.

After the pull completes, your local branch will be updated with the latest changes from the remote repository.

View Git Commit History in Android Studio

Android Studio’s Git Log lets you view the commit history for your repository, including when commits were made, who made them, and how branches relate to one another.

Open the Git tool window and select Log.

You can use the log to review commit history, inspect branches, and understand how changes have progressed through the repository.

Next Steps

Now that you’ve learned how to use GitHub with Android Studio, continue exploring these Android development resources:

• QuickBlox Android SDK source code and samples on GitHub — https://github.com/QuickBlox/quickblox-android-sdk
• Android SDK documentation — https://docs.quickblox.com/sdks/android-quick-start
• QuickBlox Developer Discord Community — https://discord.com/invite/3cKRunq8ZZ