GitHub is a cloud-hosted Git management tool. Git is distributed version control, meaning the entire repository and history lives wherever you put it. People tend to use GitHub in their business or development workflow as a managed hosting solution for backups of their repositories. GitHub takes this even further by letting you connect with coworkers, friends, organizations, and more. Show
In this tutorial, you will learn how to take an existing project you are working on and push it, so it also exists on GitHub. PrerequisitesTo initialize the repo and push it to GitHub you’ll need:
Step 1 — Create a new GitHub RepoSign in to GitHub and create a new empty repo. You can choose to either initialize a README or not. It doesn’t really matter because we’re just going to override everything in this remote repository anyways.
Warning: Through the rest of this tutorial, we’ll assume your GitHub username is sammy and the repo you created is named my-new-project. It is important that you replace these placeholders with your actual username and repo name. Step 2 — Initialize Git in the project folderFrom your terminal, run the following commands after navigating to the folder you would like to add. Initialize the Git RepoMake sure you are in the root directory of the project you want to push to GitHub and run:
Note: If you already have an initialized Git repository, you can skip this command. This step creates a hidden .git directory in your project folder, which the git software recognizes and uses to store all the metadata and version history for the project. Add the files to Git indexThe git add command is used to tell git which files to include in a commit, and the -A (or --all) argument means “include all”. Commit Added Files
The git commit command creates a new commit with all files that have been “added”. The -m (or --message) sets the message that will be included alongside the commit, used for future reference to understand the commit. In this case, the message is: 'Added my project'. Add a new remote origin
Note: Remember, you will need to replace the highlighted parts of the username and repo name with your own username and repo name. In git, a “remote” refers to a remote version of the same repository, which is typically on a server somewhere (in this case, GitHub). “origin” is the default name git gives to a remote server (you can have multiple remotes) so git remote add origin is instructing git to add the URL of the default remote server for this repo. Push to GitHub
The -u (or --set-upstream) flag sets the remote origin as the upstream reference. This allows you to later perform git push and git pull commands without having to specify an origin since we always want GitHub in this case. The -f (or --force) flag stands for force. This will automatically overwrite everything in the remote directory. We’re using it here to overwrite the default README that GitHub automatically initialized.
Note: If you did not include the default README when creating the project on GitHub, the -f flag isn’t really necessary. All together
ConclusionNow you are all set to track your code changes remotely in GitHub! As a next step, here’s a complete guide to how to use git. Once you start collaborating with others on the project, you’ll want to know how to create a pull request. Join our DigitalOcean community of over a million developers for free! Get help and share knowledge in our Questions & Answers section, find tutorials and tools that will help you grow as a developer and scale your project or business, and subscribe to topics of interest. Sign up
Git is an open-source distributed version control system. GitLab is built on top of Git. You can do many Git operations directly in GitLab. However, the command line is required for advanced tasks, like fixing complex merge conflicts or rolling back commits. If you’re new to Git and want to learn by working in your own project, learn how to make your first commit. For a quick reference of Git commands, download a Git Cheat Sheet. For more information about the advantages of working with Git and GitLab: To help you visualize what you’re doing locally, you can install a Git GUI app. Choose a terminalTo execute Git commands on your computer, you must open a terminal (also known as command prompt, command shell, and command line). Here are some options:
Confirm Git is installedYou can determine if Git is already installed on your computer by opening a terminal and running this command: If Git is installed, the output is: If your computer doesn’t recognize git as a command, you must install Git. Configure GitTo start using Git from your computer, you must enter your credentials to identify yourself as the author of your work. The username and email address should match the ones you use in GitLab.
You can read more on how Git manages configurations in the Git configuration documentation. Choose a repositoryBefore you begin, choose the repository you want to work in. You can use any project you have permission to access on GitLab.com or any other GitLab instance. To use the repository in the examples on this page: The project becomes available at https://gitlab.com/<your-namespace>/sample-project/. You can fork any project you have access to. Clone a repositoryWhen you clone a repository, the files from the remote repository are downloaded to your computer, and a connection is created. This connection requires you to add credentials. You can either use SSH or HTTPS. SSH is recommended. Clone with SSHClone with SSH when you want to authenticate only one time.
You can also clone a repository and open it directly in Visual Studio Code. Clone with HTTPSClone with HTTPS when you want to authenticate each time you perform an operation between your computer and GitLab.
On Windows, if you enter your password incorrectly multiple times and an Access denied message appears, add your namespace (username or group) to the path: git clone https:///gitlab-org/gitlab.git. Clone using a tokenClone with HTTPS using a token if:
You can use any of these tokens to authenticate when cloning over HTTPS: git clone https://<username>:<token>@gitlab.example.com/tanuki/awesome_project.git Convert a local directory into a repositoryYou can initialize a local folder so Git tracks it as a repository.
Add a remoteYou add a “remote” to tell Git which remote repository in GitLab is tied to the specific local folder on your computer. The remote tells Git where to push or pull from. To add a remote to your local copy:
After you’ve done that, you can stage your files and upload them to GitLab. View your remote repositoriesTo view your remote repositories, type: The -v flag stands for verbose. Download the latest changes in the projectTo work on an up-to-date copy of the project, you pull to get all the changes made by users since the last time you cloned or pulled the project. Replace <name-of-branch> with the name of your default branch to get the main branch code, or replace it with the branch name of the branch you are currently working in. git pull <REMOTE> <name-of-branch> When you clone a repository, REMOTE is typically origin. This is where the repository was cloned from, and it indicates the SSH or HTTPS URL of the repository on the remote server. <name-of-branch> is usually the name of your default branch, but it may be any existing branch. You can create additional named remotes and branches as necessary. You can learn more on how Git manages remote repositories in the Git Remote documentation. BranchesA branch is a copy of the files in the repository at the time you create the branch. You can work in your branch without affecting other branches. When you’re ready to add your changes to the main codebase, you can merge your branch into the default branch, for example, main. Use branches when you:
A new branch is often called feature branch to differentiate from the default branch. Create a branchTo create a feature branch: git checkout -b <name-of-branch> Branch names cannot contain empty spaces and special characters. Use only lowercase letters, numbers, hyphens (-), and underscores (_). Switch to a branchAll work in Git is done in a branch. You can switch between branches to see the state of the files and work in that branch. To switch to an existing branch: git checkout <name-of-branch> For example, to change to the main branch: View differencesTo view the differences between your local unstaged changes and the latest version that you cloned or pulled: View the files that have changesWhen you add, change, or delete files or folders, Git knows about the changes. To check which files have been changed: Add and commit local changesWhen you type git status, locally changed files are shown in red. These changes may be new, modified, or deleted files or folders.
Stage and commit all changesAs a shortcut, you can add all local changes to staging and commit them with one command: git commit -a -m "COMMENT TO DESCRIBE THE INTENTION OF THE COMMIT" Send changes to GitLab.comTo push all local changes to the remote repository: git push <remote> <name-of-branch> For example, to push your local commits to the main branch of the origin remote: Sometimes Git does not allow you to push to a repository. Instead, you must force an update. Delete all changes in the branchTo discard all changes to tracked files: This action removes changes to files, not the files themselves. Untracked (new) files do not change. Unstage all changes that have been added to the staging areaTo unstage (remove) all files that have not been committed: Undo most recent commitTo undo the most recent commit: This action leaves the changed files and folders unstaged in your local repository.
A Git commit should not be reversed if you already pushed it to the remote repository. Although you can undo a commit, the best option is to avoid the situation altogether by working carefully. You can learn more about the different ways Git can undo changes in the Git Undoing Things documentation. Merge a branch with default branchWhen you are ready to add your changes to the default branch, you merge the feature branch into it: git checkout <default-branch> git merge <feature-branch> In GitLab, you typically use a merge request to merge your changes, instead of using the command line. To create a merge request from a fork to an upstream repository, see the forking workflow. Advanced use of Git through the command lineFor an introduction of more advanced Git techniques, see Git rebase, force-push, and merge conflicts. Synchronize changes in a forked repository with the upstreamTo create a copy of a repository in your namespace, you fork it. Changes made to your copy of the repository are not automatically synchronized with the original. To keep the project in sync with the original project, you need to pull from the original repository. You must create a link to the remote repository to pull changes from the original repository. It is common to call this remote repository the upstream. You can now use the upstream as a <remote> to pull new updates from the original repository, and use the origin to push local changes and create merge requests. |