How to Upload Android Studio Project to GitHub?
Simple and beginner-friendly step-by-step guides to share your Android project in GitHub repository
3 min read
Table of contents
- Step 1 - Sign Up GitHub and Install Git
- Step 2 - Enable Version Control Integration
- Step 3 - Share Project on GitHub
- Make Changes to Your Files
- Show Diff Before Commit
The good thing about using Android Studio to upload your files to GitHub is it automatically figures out for you what files are required to commit and push to GitHub. For example, generated files are not required to commit and push to GitHub.
The following provides the step-by-step instructions on how you can upload your Android studio projects to GitHub:
Step 1 - Sign Up GitHub and Install Git
- Sign up github.com
- Download and install git from here
Step 2 - Enable Version Control Integration
In your Android Studio, go to menu "VCS→Enable Version Control Integration..."
Select "Git" and click "OK"
Update: Feb 8, 2022: I learned that the
.idea folder is unnecessary to be committed to repository because those files are specific to IDE configurations, which could be different per developer. In this case, you can update the
.gitignore file to exclude them.
.gitignoreto ignore the entire
.ideafolder (optional step)
In your root project folder, you should see
.gitignore which have the following default ignore for certain files and folders in the
/.idea/caches /.idea/libraries /.idea/modules.xml /.idea/workspace.xml /.idea/navEditor.xml /.idea/assetWizardSettings.xml
To ignore the entire
.idea folder instead.
Step 3 - Share Project on GitHub
Go to menu "Git→GitHub→Share Project on GitHub"
Login GitHub account either via GitHub website or with token. GitHub website login didn't work for me. So I ended up use token instead.
Click "Generate..." and follow the instructions to get the generated token
Copy and paste the token, click "Add Account"
Name your repository name, check "Private" if you want to create a private repository. Then, click "Share". A new repository is created.
Click "Add" to commit your files
That is it. Your project now has been uploaded to your GitHub repository. After you make some local changes to your file, you need to commit and push those changes into a GitHub repository. The following steps show you how to do that.
Make Changes to Your Files
Step 1 - Commit your files
- Click "commit" in the top right corner. You can also go to menu "Git→Commit"
Step 2 - Push your files
Enter your commit description and click "Commit and Push..."
There are code analysis warnings, you can either review them or just go ahead to push your files
Click "Push". Your files have been updated in the repository
You can also click "Commit" and push your files later on. To push your files, click "push" in the top right corner. You can also go to menu "Git→Push". The rest of the steps are very similar to "Commit and Push" above.
Another common thing I do before I commit the files is review my changes. The following steps show you how you can review and make any changes to your files in the committing screen.
Show Diff Before Commit
Step 1 - Show Diff
- Select a file, right click and click "Show Diff"
Step 2 - Select "step-by-step viewer"
- By default, it is "Unified viewer" which I don't like.
Step 3 - Review and Make Changes
- Now you can review your change. You can also make changes to your file from this window.
Hope this helps! I’m new to GitHub and this is what I do to commit and push my Android projects into my GitHub repositories
Did you find this article valuable?
Support Vincent Tsen by becoming a sponsor. Any amount is appreciated!