Skip to content

G
gitlab-ce
Commit b351e6f5 authored by Job van der Voort's avatar Job van der Voort
Browse files
Options

Merge branch 'create-branch' into 'master' 

Added new doc about creating a new branch

Added new document about creating a branch and fixed bullets in all the other documents. Also fixed "git push REMOTE BRANCH".

See merge request !1894
parents 9b6f1c59 70a08ace
Hide whitespace changes
Inline Side-by-side
Showing with 100 additions and 66 deletions
doc/gitlab-basics/README.md
View file @ b351e6f5
...@@ -13,3 +13,5 @@ Step-by-step guides on the basics of working with Git and GitLab. ...@@ -13,3 +13,5 @@ Step-by-step guides on the basics of working with Git and GitLab.
* [Create a project](create-project.md) * [Create a project](create-project.md)
* [Create a group](create-group.md) * [Create a group](create-group.md)
* [Create a branch](create-branch.md)
doc/gitlab-basics/basic-git-commands.md
View file @ b351e6f5
# Basic Git commands # Basic Git commands
* Go to the master branch to pull the latest changes from there ### Go to the master branch to pull the latest changes from there
``` ```
git checkout master git checkout master
``` ```
* Download the latest changes in the project, so that you work on an up-to-date copy (this is important to do every time you work on a project), while you setup tracking branches ### Download the latest changes in the project
This is for you to work on an up-to-date copy (it is important to do every time you work on a project), while you setup tracking branches.
``` ```
git pull REMOTE NAME-OF-BRANCH -u git pull REMOTE NAME-OF-BRANCH -u
``` ```
(REMOTE: origin) (NAME-OF-BRANCH: could be "master" or an existing branch) (REMOTE: origin) (NAME-OF-BRANCH: could be "master" or an existing branch)
* Create a branch (remember that spaces won't be recognized, you need to use a hyphen or underscore) ### Create a branch
Spaces won't be recognized, so you need to use a hyphen or underscore.
``` ```
git checkout -b NAME-OF-BRANCH git checkout -b NAME-OF-BRANCH
``` ```
* Work on a branch that has already been created ### Work on a branch that has already been created
``` ```
git checkout NAME-OF-BRANCH git checkout NAME-OF-BRANCH
``` ```
* To see the changes you've made (it's important to be aware of what's happening and what's the status of your changes) ### View the changes you've made
It's important to be aware of what's happening and what's the status of your changes.
``` ```
git status git status
``` ```
* Add changes to commit (you'll be able to see your changes in red when you type "git status") ### Add changes to commit
You'll see your changes in red when you type "git status".
``` ```
git add CHANGES IN RED git add CHANGES IN RED
git commit -m "DESCRIBE THE INTENTION OF THE COMMIT" git commit -m "DESCRIBE THE INTENTION OF THE COMMIT"
``` ```
* Send changes to gitlab.com ### Send changes to gitlab.com
``` ```
git push origin NAME-OF-BRANCH git push REMOTE NAME-OF-BRANCH
``` ```
* Throw away all changes in the Git repository, but leave unstaged things ### Delete all changes in the Git repository, but leave unstaged things
``` ```
git checkout . git checkout .
``` ```
* Delete all changes in the Git repository, including untracked files ### Delete all changes in the Git repository, including untracked files
``` ```
git clean -f git clean -f
``` ```
* Remove all the changes that you don't want to send to gitlab.com ### Merge created branch with master branch
``` You need to be in the created branch.
git add NAME-OF-FILE -all
```
* Merge created branch with master branch. You need to be in the created branch
``` ```
git checkout NAME-OF-BRANCH git checkout NAME-OF-BRANCH
git merge master git merge master
......
doc/gitlab-basics/command-line-commands.md
View file @ b351e6f5
...@@ -2,46 +2,47 @@ ...@@ -2,46 +2,47 @@
## Start working on your project ## Start working on your project
* In Git, when you copy a project you say you "clone" it. To work on a git project locally (from your own computer), you will need to clone it. To do this, sign in to [GitLab.com](https://gitlab.com) In Git, when you copy a project you say you "clone" it. To work on a git project locally (from your own computer), you will need to clone it. To do this, sign in to [GitLab.com](https://gitlab.com).
* When you are on your Dashboard, click on the project that you'd like to clone, which you'll find at the right side of your screen When you are on your Dashboard, click on the project that you'd like to clone, which you'll find at the right side of your screen.
![Select a project](basicsimages/select_project.png) ![Select a project](basicsimages/select_project.png)
* To work in the project, you can copy a link to the Git repository through a SSH or a HTTPS protocol. SSH is easier to use after it's been [setup](create-your-ssh-keys.md). When you're in the project, click on the HTTPS or SSH button at the right side of your screen. Then copy the link (you'll have to paste it on your shell in the next step) To work in the project, you can copy a link to the Git repository through a SSH or a HTTPS protocol. SSH is easier to use after it's been [setup](create-your-ssh-keys.md). When you're in the project, click on the HTTPS or SSH button at the right side of your screen. Then copy the link (you'll have to paste it on your shell in the next step).
![Copy the HTTPS or SSH](basicsimages/https.png) ![Copy the HTTPS or SSH](basicsimages/https.png)
## On the command line ## On the command line
* To clone your project, go to your computer's shell and type the following command ### Clone your project
Go to your computer's shell and type the following command:
``` ```
git clone PASTE HTTPS OR SSH HERE git clone PASTE HTTPS OR SSH HERE
``` ```
* A clone of the project will be created in your computer A clone of the project will be created in your computer.
* Go into a project, directory or file to work in it ### Go into a project, directory or file to work in it
``` ```
cd NAME-OF-PROJECT-OR-FILE cd NAME-OF-PROJECT-OR-FILE
``` ```
* Go back one directory or file ### Go back one directory or file
``` ```
cd ../ cd ../
``` ```
* To see what’s in the directory that you are in ### View what’s in the directory that you are in
``` ```
ls ls
``` ```
* Create a directory ### Create a directory
``` ```
mkdir NAME-OF-YOUR-DIRECTORY mkdir NAME-OF-YOUR-DIRECTORY
``` ```
* Create a README.md or file in directory ### Create a README.md or file in directory
``` ```
touch README.md touch README.md
nano README.md nano README.md
...@@ -51,22 +52,23 @@ nano README.md ...@@ -51,22 +52,23 @@ nano README.md
#### Press: enter #### Press: enter
``` ```
* Remove a file ### Remove a file
``` ```
rm NAME-OF-FILE rm NAME-OF-FILE
``` ```
* Remove a directory and all of its contents ### Remove a directory and all of its contents
``` ```
rm -rf NAME-OF-DIRECTORY rm -rf NAME-OF-DIRECTORY
``` ```
* View history in the command line ### View history in the command line
``` ```
history history
``` ```
* Carry out commands for which the account you are using lacks authority. (You will be asked for an administrator’s password) ### Carry out commands for which the account you are using lacks authority
You will be asked for an administrator’s password.
``` ```
sudo sudo
``` ```
doc/gitlab-basics/create-branch.md 0 → 100644
View file @ b351e6f5
# How to create a branch
A branch is an independent line of development.
New commits are recorded in the history for the current branch, which results in taking the source from someone’s repository (the place where the history of your work is stored) at certain point in time, and apply your own changes to it in the history of the project.
To add changes to your GitLab project, you should create a branch. You can do it in your [shell](basic-git-commands.md) or in GitLab.
To create a new branch in GitLab, sign in and then select a project on the right side of your screen:
![Select a project](basicsimages/select_project.png)
Click on "commits" on the menu on the left side of your screen:
![Commits](basicsimages/commits.png)
Click on the "branches" tab:
![Branches](basicsimages/branches.png)
Click on the "new branch" button on the right side of the screen:
![New branch](basicsimages/newbranch.png)
Fill out the information required:
1. Add a name for your new branch (you can't add spaces, so you can use hyphens or underscores)
1. On the "create from" space, add the the name of the branch you want to branch off from
1. Click on the button "create branch"
![Branch info](basicsimages/branch_info.png)
### Note:
You will be able to find and select the name of your branch in the white box next to a project's name:
![Branch name](basicsimages/branch_name.png)
doc/gitlab-basics/create-project.md
View file @ b351e6f5
# How to create a project in GitLab # How to create a project in GitLab
## Create a project To create a new project, sign in to [GitLab.com](https://gitlab.com).
* Sign in to [GitLab.com](https://gitlab.com) Go to your Dashboard and click on "new project" on the right side of your screen.
* Go to your Dashboard and click on "new project" on the right side of your screen
![Create a project](basicsimages/new_project.png) ![Create a project](basicsimages/new_project.png)
* Fill out the required information Fill out the required information:
1. Project path or the name of your project (you can't add spaces, so you can use hyphens or underscores) 1. Project path or the name of your project (you can't add spaces, so you can use hyphens or underscores)
......
doc/gitlab-basics/create-your-ssh-keys.md
View file @ b351e6f5
...@@ -4,34 +4,34 @@ You need to connect your computer to your GitLab account through SSH Keys. They ...@@ -4,34 +4,34 @@ You need to connect your computer to your GitLab account through SSH Keys. They
## Generate your SSH Key ## Generate your SSH Key
* Create an account on GitLab. Sign up and check your email for your confirmation link Create an account on GitLab. Sign up and check your email for your confirmation link.
* After you confirm, go to [GitLab.com](https://about.gitlab.com/) and sign in to your account After you confirm, go to [GitLab.com](https://about.gitlab.com/) and sign in to your account.
## Add your SSH Key ## Add your SSH Key
* At the top right corner, click on "profile settings" At the top right corner, click on "profile settings":
![profile settings](basicsimages/profile_settings.png) ![profile settings](basicsimages/profile_settings.png)
* On the left side menu click on "SSH Keys" On the left side menu click on "SSH Keys":
![SSH Keys](basicsimages/shh_keys.png) ![SSH Keys](basicsimages/shh_keys.png)
* Then click on the green button "Add SSH Key" Then click on the green button "Add SSH Key":
![Add SSH Key](basicsimages/add_sshkey.png) ![Add SSH Key](basicsimages/add_sshkey.png)
* There, you should paste the SSH Key that your commandline will generate for you. Below you'll find the steps to generate it There, you should paste the SSH Key that your command line will generate for you. Below you'll find the steps to generate it:
![Paste SSH Key](basicsimages/paste_sshkey.png) ![Paste SSH Key](basicsimages/paste_sshkey.png)
## To generate an SSH Key on your commandline ## To generate an SSH Key on your command line
* Go to your [commandline](start-using-git.md) and follow the [instructions](https://gitlab.com/help/ssh/README) to generate it Go to your [command line](start-using-git.md) and follow the [instructions](../ssh/README.md) to generate it.
* Copy the SSH Key that your commandline created and paste it on the "Key" box on the GitLab page. The title will be added automatically Copy the SSH Key that your command line created and paste it on the "Key" box on the GitLab page. The title will be added automatically.
![Paste SSH Key](basicsimages/key.png) ![Paste SSH Key](basicsimages/key.png)
* Now, you'll be able to use Git over SSH, instead of Git over HTTP. Now, you'll be able to use Git over SSH, instead of Git over HTTP.
doc/gitlab-basics/start-using-git.md
View file @ b351e6f5
# Start using Git on the commandline # Start using Git on the command line
If you want to start using a Git and GitLab, make sure that you have created an account on [GitLab.com](https://about.gitlab.com/) If you want to start using a Git and GitLab, make sure that you have created an account on [GitLab.com](https://about.gitlab.com/).
## Open a shell ## Open a shell
* Depending on your operating system, find the shell of your preference. Here are some suggestions Depending on your operating system, find the shell of your preference. Here are some suggestions.
- [Terminal](http://blog.teamtreehouse.com/introduction-to-the-mac-os-x-command-line) on Mac OSX - [Terminal](http://blog.teamtreehouse.com/introduction-to-the-mac-os-x-command-line) on Mac OSX
...@@ -14,54 +14,48 @@ If you want to start using a Git and GitLab, make sure that you have created an ...@@ -14,54 +14,48 @@ If you want to start using a Git and GitLab, make sure that you have created an
## Check if Git has already been installed ## Check if Git has already been installed
* Git is usually preinstalled on Mac and Linux Git is usually preinstalled on Mac and Linux.
* Type the following command and then press enter
Type the following command and then press enter:
``` ```
git --version git --version
``` ```
* You should receive a message that will tell you which Git version you have in your computer. If you don’t receive a "Git version" message, it means that you need to [download Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) You should receive a message that will tell you which Git version you have in your computer. If you don’t receive a "Git version" message, it means that you need to [download Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
* If Git doesn't automatically download, there's an option on the website to [download manually](https://git-scm.com/downloads). Then follow the steps on the installation window If Git doesn't automatically download, there's an option on the website to [download manually](https://git-scm.com/downloads). Then follow the steps on the installation window.
* After you finished installing, open a new shell and type "git --version" again to verify that it was correctly installed After you finished installing, open a new shell and type "git --version" again to verify that it was correctly installed.
## Add your Git username and set your email ## Add your Git username and set your email
* It is important because every Git commit that you create will use this information It is important because every Git commit that you create will use this information.
* On your shell, type the following command to add your username
On your shell, type the following command to add your username:
``` ```
git config --global user.name ADD YOUR USERNAME git config --global user.name ADD YOUR USERNAME
``` ```
* Then verify that you have the correct username Then verify that you have the correct username:
``` ```
git config --global user.name git config --global user.name
``` ```
* To set your email address, type the following command To set your email address, type the following command:
``` ```
git config --global user.email ADD YOUR EMAIL git config --global user.email ADD YOUR EMAIL
``` ```
* To verify that you entered your email correctly, type To verify that you entered your email correctly, type:
``` ```
git config --global user.email git config --global user.email
``` ```
* You'll need to do this only once because you are using the "--global" option. It tells Git to always use this information for anything you do on that system. If you want to override this with a different username or email address for specific projects, you can run the command without the "--global" option when you’re in that project You'll need to do this only once because you are using the "--global" option. It tells Git to always use this information for anything you do on that system. If you want to override this with a different username or email address for specific projects, you can run the command without the "--global" option when you’re in that project.
## Check your information ## Check your information
* To view the information that you entered, type To view the information that you entered, type:
``` ```
git config --global --list git config --global --list
``` ```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7