~~~CONFIG:title~~~
created by NETWAYS GmbH
+
+
+
+
+
+
+!SLIDE noprint
+# NETWAYS Trainings
+
+.margin-top-1-5 
diff --git a/global/pre/netways/title/00_title.md b/global/pre/netways/title/00_title.md
new file mode 100644
index 0000000..3194b5d
--- /dev/null
+++ b/global/pre/netways/title/00_title.md
@@ -0,0 +1,16 @@
+!SLIDE printonly
+
+
+~~~CONFIG:name~~~
~~~CONFIG:subtitle~~~
+~~~CONFIG:name~~~
~~~CONFIG:subtitle~~~
+~~~CONFIG:name~~~
~~~CONFIG:subtitle~~~
+~~~CONFIG:name~~~
~~~CONFIG:subtitle~~~
-
+ 
-
-
-$ apt-get install git$ yum install git$ dnf install git$ apt-get install bash-completionThe most simple version control system is to copy -directories and add a suffix like the last date it -worked. Though this might cause trouble when you're -in the wrong directory. Afterall it pollutes your -filesystem structure over time.
+Long time ago developers invented version control -systems which store the file revisions in a database.
+$ yum install bash-completion$ dnf install bash-completion
$ wget https://raw.githubusercontent.com/git/git/master/contrib/completion/git-prompt.sh$ vim $HOME/.bashrc
+source ~/git-prompt.sh
+export GIT_PS1_SHOWDIRTYSTATE=1
+export PS1='[\u@\h] \W$(__git_ps1 " (%s)") \$ '
+
+$ source $HOME/.bashrcOpen Source Training
+by NETWAYS (netways.de)
+
$ git config --global user.name "Michael Friedrich"$ git config --global user.email "michael.friedrich@netways.de"$ git config --global --listBitKeeper
-Git
-In addition to that you can open the .gitconfig file in your $HOME directory.
$ less $HOME/.gitconfig
+You can also use git config --global --list to list all configured options.
+
$ cd $HOME
+$ git clone https://github.com/Icinga/icinga2.git$ cd $HOME
+$ mkdir training
+$ cd training
+$ git init$ cd $HOME/training
+$ echo "# Git Training Notes" > README.md
+$ git add README.md
+$ git status
+
$ cd $HOME/training
+
+$ git status
+
+$ git reset --soft README.md
+
+$ git status
+
+$ git add README.md
+
+$ git statusExample:
+7f0b824ba55e1fd4ffc5c461df0a0f48a94195cc
-$ cd $HOME/training
-
-Modify and save the file.
+ +$ git statusYou'll recognize the unstaged changes compared to your staging area.
+ +$ git add README.md$ git status
$ vim README.md
+I've also learned the difference between local changes and the staging area.Modify and save the file.
-Modified means that you have changed the file but have not committed
-it to your Git database yet.
$ git diffStaged means that you have marked a modified or added file in its
-current version to go into your next commit snapshot.
You'll recognize the unstaged changes compared to your staging area.
-Committed means that the data is safely stored in your local database.
The working directory is a single checkout of one version of the project.
-These files are pulled out of the compressed database in the Git directory
-and placed on disk for you to use or modify.
$ git add README.mdThe staging area is a file, generally located in your Git directory, that
-stores information about what will go into your next commit.
-It is sometimes referred to as the "index", but it’s also common to refer
-to it as the staging area.
The Git directory is where Git stores the metadata and object database
-for your project. This is the most important part of Git, and it is what
-is copied when you clone a repository from another computer.
$ git diffworking directory
-staging area ("git add")staging area
-.git directory
-Create a dummy file and directory which contains a file itself. This is +for simulating unwanted files in the working directory.
-$ cd $HOME/training
-
-If a particular version of a file is in the .git directory, it’s considered committed.
Staged means that the file has been modified and it was added to the staging area
Modified means that the file was changed since it was checked out but has not been staged yet.
+$ touch generated.tmp
+$ mkdir debug
+$ touch debug/.timestamp$ git status
+On branch master
-
-- Work on the CLI
-- GUIs implement partial feature sets of the CLI tool
-- Shell sub commands
-- Bash-completion
-
+Untracked files:
+ (use "git add <file>..." to include in what will be committed)
+ debug/
+ generated.tmp$ vim .gitignore
+*.tmp
+debug/Files matching the *.tmp pattern in the current directory
+will be excluded. Furthermore the debug directory (note the
+trailing slash).
$ git status
+On branch master
+Untracked files:
+ (use "git add <file>..." to include in what will be committed)
+
+ .gitignoreWe'll learn how to add and commit the untracked .gitignore file
+in later examples.
+
$ cd $HOME/training
-
-$ git status
+$ git commit -v README.md
+ Update training notes
-
-- Install the
git package
-
-$ git logOpen Source Training
+by NETWAYS (netways.de)
+
bash-completion packagebash-completion packagegit-prompt.sh script from https://github.com/git/git - contrib/completion/git-prompt.sh
-$HOME/.bashrc file$ cd $HOME/training
+$ git status
+$ git add .gitignore
+$ git commit -v .gitignore -m "Add .gitignore file"$ git log$ git show
+$ git show <commitid>
+$ git show -2$ git diff
+$ git diff <commitid1> <commitid2>
CentOS 7 (requires the EPEL repository):
+ +# yum install epel-release
+# yum makecache
+# yum install tig
Debian/Ubuntu
+# apt-get install tig$ cd $HOME/training
+$ tig
+
+@@@ Sh
+$ cd $HOME/icinga2
+$ tigThe Powerline shell integration can be found here: https://github.com/b-ryan/powerline-shell
+# yum -y install epel-release
-# yum -y install python-pip
-# pip install powerline-shell
+Add the files
-@@@ Sh
-$ vim $HOME/.bashrc
+$ cd $HOME/training
-function _update_ps1() {
- PS1=$(powerline-shell $?)
-}
+$ vim README.md
-if [[ $TERM != linux && ! $PROMPT_COMMAND =~ _update_ps1 ]]; then
- PROMPT_COMMAND="_update_ps1; $PROMPT_COMMAND"
-fi
+`git commit --amend` adds missing changes to the previous commit.Powerline needs an additional font which can be downloaded from here: -https://github.com/powerline/fonts/blob/master/Meslo%20Slashed/Meslo%20LG%20M%20Regular%20for%20Powerline.ttf
+Choose Raw and install it into your system.
$ git add README.md
+$ git status
+$ git commit -v README.md -m "Add documentation for Amend"Modify your terminal profile settings and choose Meslo LG as font.
$ vim README.md
-The Windows Powershell integration requires NuGet. Open a new Powershell prompt and enter:
+`git commit --amend` adds missing changes to the previous commit.
+I'm also able to edit the commit message.
-Install-Module git-posh
-Add-PoshGitToProfile
+$ git add README.md
+$ git status$ git commit --amend -v README.md
+ Add documentation for 'git amend'Adopt the commit message as additional exercise above.
+ +$ git status
+$ git show$HOME/.gitconfigtraining/.git/config
-Example:
- -$ git config --global color.ui auto
-
-$ cat $HOME/.gitconfig
-[color]
-ui = autoMore information can be found in the documentation at -https://git-scm.com/book/tr/v2/Customizing-Git-Git-Configuration
- -
-user)alias)color)core)Example:
- -
-git config --global user.name "Your Name"
-git config --global user.email "name@domain.com"
-git config --global --list
-
-
-Example from Git CLI command:
- -start a working area (see also: git help tutorial)
- clone Clone a repository into a new directory
- init Create an empty Git repository or reinitialize an existing one
-
-work on the current change (see also: git help everyday)
- add Add file contents to the index
- mv Move or rename a file, a directory, or a symlink
- reset Reset current HEAD to the specified state
- rm Remove files from the working tree and from the index
-
-examine the history and state (see also: git help revisions)
- bisect Use binary search to find the commit that introduced a bug
- grep Print lines matching a pattern
- log Show commit logs
- show Show various types of objects
- status Show the working tree status
-
-grow, mark and tweak your common history
- branch List, create, or delete branches
- checkout Switch branches or restore working tree files
- commit Record changes to the repository
- diff Show changes between commits, commit and working tree, etc
- merge Join two or more development histories together
- rebase Forward-port local commits to the updated upstream head
- tag Create, list, delete or verify a tag object signed with GPG
-
-collaborate (see also: git help workflows)
- fetch Download objects and refs from another repository
- pull Fetch from and integrate with another repository or a local branch
- push Update remote refs along with associated objects
-git clone
-
-git init
-
-git clone clones a copy of an existing remote Git repository.
git init initializes an empty directory as local Git repository.
When you clone a repository, Git automatically adds a shortcut called
-origin that points back to the "parent" repository, under the assumption
-that you'll want to interact with it further on down the road. This is
-called an origin.
-git clone to clone the remote Git repository
-training in your home directorygit init
-We will be working inside the training directory throughout the training
-unless noted otherwise.
-git add
-
-git mv
-
-git add will add the file(s) and their content to the staging index
-waiting for the commit.
git mv renames an existing file tracking the change for the commit. If you
-manually move the file, you will need to rm and add it again.
-git reset
-
---soft keeps the changes (default), --hard removes them indefinitely.git rm
-
-git reset resets files added to the staging index.
git rm removes the file from the working tree and also from the git index.
-$HOME/training
-# Git Training Notes as first linegit add to add README.md to the current change indexgit status
-Best practice is to have a README.md file written in Markdown -in every project. This gets rendered by GitHub/GitLab in readable HTML.
- -During this training we will learn many new things. Keep notes
-in the README.md file.
-$HOME/training
-README.md file from the staging index with git reset --soft README.md
-git status and explain what happened.README.md and examine again with git status.
-git status
-
-Untracked files and added to staging area.git diff
-
-Later we will learn how to compare specific commits and branches too.
- - - - -git status shows the current working tree status. Untracked files and changes (not) staged
-for commit.
git diff shows changes between the current working tree and the last commit. You can
-also compare specific commits.
-$HOME/training
-git status to see unstaged changesgit status again
-git diff
-$HOME/training
-git diff to compare unstaged changesgit diff again.git repository
-
-debug, release)You can use wildcard pattern matches for files. -If you'll end the string with a '/' git will only -ignore directories instead of both directories and files -matching the pattern.
- -If you want to ignore a file globally in your repository
-you can preceed the path with **/ which means any directory.
Example for ignoring a debug file anywhere in your repository:
- -**/debug
-If you prefer to keep .gitignore files in specific directories
-and not a global file, this will also work.
-$HOME/training
-generated.tmp
-debug with the file .timestamp
-git status
-git status
-
-
-
-git commit
-
--a) not necessarily added to the staging index-v)-m allows for a short commit message without editor viewCommits use the user.name and user.email settings to qualify
-you as the author of this change. In addition to that the date
-and time is stored.
git commit collects and records all changes stages for commit. It uses the configured
-user name and email address as commit author. This command opens the configured editor
-requiring you to add a commit message.
-$HOME/training
-README.md file and add more docsgit commit -v README.md
-git log to verify the history
-git add for all changes in a filegit add -p for interactive selection of changes in a filegit commit <file1> <file2>-v to show the differences below the editor
-
-
-Example:
- -A short subject for the commit line
-<newline>
-Some body text explaining the issue.
-80-120 characters max width.
-<newline>
-refs #<ticketid>
-git log
-
--10 notation to show a limited number of commits.git log shows the commit history of the current branch.
-git show
-
--10 notation to show a limited number of commits.git diff
-
-git show will print the last commit details. If you want to print a specific commit id, add
-it afterwards.
git diff shows changes between the current working tree and the last commit. You can
-also compare specific commits.
-$HOME/training
-.gitignore
-git log to print the current historygit show to show specific commits (defaults to the latest)git diff to compare changes between specific revisions
-tig helps visualize history and branches
-tig package$HOME/training
-$HOME/icinga2
-Enter
-q quits the detail view and the application
-git commit --amend changes the latest commit
-
-git rebase.If you amend changes to a specific commit, a new unique commit id is generated. -This changes the Git history and we will learn later how to resolve possible -problems in collaboration with others.
- - - - -
-$HOME/training
-README.md and add docs about amendREADME.md to the staging index and commit the changeREADME.md again and add it to staginggit commit --amend README.md and explain what happensgit commit --amend
-
-
-A git branch creates a new history line starting from the current -git commit.
- -Branches are useful to develop features/fixes in their isolated -environment.
- -
-git branch
-
-git checkout
-
-git branch allows you to list, create and delete branches.
git checkout will switch between branches, or restore your current working tree.
-$HOME/training
-git branch to highlight the current branch
-$HOME/training
-feature/docs based off master with git branch feature/docs master
-git branch
-git checkout feature/docs
-git checkout -b feature/docs2
-
-$HOME/training
-git branch -d to delete the selected branch
-A git commit is unique and identified by its SHA1 checksum.
- -HEAD is a pointer to the latest commit in the current branch.
HEAD^ identifies the second latest commit.
HEAD~9 points to the tenth latest commit. Counting starts at zero.
This can be used for git show. More advanced techniques will be discussed later.
-HEAD and only show the second latest commit.$HOME/training
-git show with HEAD^ or HEAD~1
-
-feature/docs as branch name also points to the latest commit.
You don't need to change branches to
- -Example:
- -$ git show feature/docs
-commit b825ff86e4022a8fbcf52cb5a1d9a1984bd2a310 (feature/docs)
-git log from the master branch on another branchgit checkout -b feature/docs
-git log feature/docs
-feature/docs branch
-
-There is a variety of Git server tools, web interfaces -and addons out there.
- -In case you don't want to host your own Git server, -there are open source and enterprise hosting options available.
- -NETWAYS also provides GitLab hosting services:
- - - -
-
-
-
-git@github.com:username/repo.githttps://my-gitlab.nws.netways.de/username/repo.gitgit://domain.com/repo.gitfile:///opt/git/repo.git
-GitLab is available as self-hosted or cloud based repository management -system.
- -Hosted: https://www.netways.de/managed_hosting/gitlab_ce_hosting/
- - - - - - -
-Overview: https://about.gitlab.com/features/ -Comparison: https://about.gitlab.com/images/feature_page/gitlab-features.pdf
- -The source code is publicly available for both editions. -You'll need a valid license for running EE in production.
- -
-It is recommended to use the Omnibus installation package or use -a managed cloud hosting service.
- - - - -Omnibus packages: https://about.gitlab.com/installation/?version=ce
- -More details on the manual installation instructions can be -found in the official documentation: https://docs.gitlab.com/ce/install/installation.html
- -
-This training focuses on a pre-installed GitLab instance.
- -Each user gets access to NWS - https://nws.netways.de -and a GitLab CE app.
- -GitLab supports working with
- -Manual installation instructions are provided in the -handout.
- - - - -
-root user.
-You can also start fresh without any local repository -and clone that from remote.
- -For training purposes we've started to work offline in $HOME/training.
-Now we want to publish the local commits to a newly created Git repository
-in GitLab.
-Generate a new SSH key pair on your client.
- -
-ssh-keygen
-
Copy the public key into your GitLab settings.
- -
-cat $HOME/.ssh/id_rsa.pub
-
User > Settings > SSH Keys
- -
-+ icon next to the search fieldNew Project
-training
-Private
-
-git config --global --get credential.helper
-/usr/libexec/git-core/git-credential-gnome-keyring on CentOS 7More details can be found in your NWS GitLab app in the FAQ section on top.
- - - - -
-HTTPS clone URL$HOME/training
-git remote add origin <remoteurl>
---set-upstream (short: -u)simple
-
-History in the project view and examine the Git commitsgit log or tig on your shell and compare them to GitLab
-
-
-git fetch
-
-git pull
-
-git fetch downloads objects and references from another remote repository.
git pull invokes a fetch and updates the local history with commits from the remote repository.
-git push
-
-git remote
-
-origin).git push updates remote references and pushes your local commit history to the remote repository.
git remote allows you to configure and list the remote repository. By default this is called origin.
-$HOME/training
-README.md and add a note on git push
-
-git reset --hard HEAD^
-
-Example for checking out a tag into a new branch:
- -$ git checkout -b version01 v0.1
-$ git branchgit tag and add the v0.1 taggit tag -l
--m
-git push --tags
-
-git stash
-
-git cherry-pick
-
-git cherry-pick collects a specific commit into your working tree.
git stash allows you put your current changes on a temporary stack (stash).
-This comes in handy when you want to change branches with a different history
-where your uncommitted changes will not apply.
-Use git stash pop to fetch the changes again. You can stash multiple uncommitted
-stages, git stash list will list them.
-$HOME/training
-README.md
-git stash list and git stash show -p
-git stash pop
-
-git reset
-
---soft adds changes to the staging index.--hard drops them indefinitely.Try it out with the trainer.
- -$ git reset --soft HEAD^
-
-$ git reset --hard HEAD^
-master branch
Compared to other VCS systems, Git provides the advantage of -also storing a local copy of the repository and branches.
- -That way a developer can work isolated on changes on its own -while other developers can do the same. These isolated environments -ensure that each developers works independantly from other -changes in the project.
- -In addition to that the Git branching model provides a fail-safe mechanism -for integrating and sharing code changes between repositories.
- -
-
-
-
-training.git repository into $HOME/training1 and $HOME/training2
-
-
-git reset --hard HEAD~2
-git diff origin/master
-git rebase origin/master
-git rebase --continue, push rebased historyHint: >>> marks conflicts and show the differences on merge.
Instead of git fetch and git rebase you can also use
-the git pull command with the additional --rebase flag.
-This helps if you are familiar with SVN and svn update.
If you forget the --rebase flag it will still work
-but generate merge commits. This will merge your commits
-in historical order but not rebase them on top of the existing
-history.
For using a centralized workflow it is better to use rebase
-instead of generating a merge commit.
-
-feature/docs-workflows
-
-feature/docs-workflows
-$HOME/training
-git checkout -b feature/docs-workflows to create a new feature branch based on the master
-Objective:
- -master branch and merge feature branch feature/docs-workflows
-Steps:
- -feature/docs-workflows
-README.md, add and commit the changesgit diff master
-master branch, merge the feature branch as non-fast-forward with --no-ff
-tig or inside GitLab and explain why the forced merge commit with --no-ff is important
-
-
-stable and in production
-develop as their parent branchdevelop
-
-develop: release branch based on develop
-master and tagged with version
-master
-master, tagged and merged to develop
-
-
-Pull Request for the official repository, CI triggers automated tests for the PR
References:
- -GitHub: https://guides.github.com/introduction/flow/ -GitLab: https://docs.gitlab.com/ce/workflow/forking_workflow.html
- -
-origin is yours, e.g. git@github.com:dnsmichi/icinga2.gitupstream is official with releases, e.g. https://github.com/icinga/icinga2.git
-origin/<branch> to upstream/<branch> and vice versaExample:
- -$ git remote -v
-origin git@github.com:dnsmichi/icinga2.git (fetch)
-origin git@github.com:dnsmichi/icinga2.git (push)
-upstream https://github.com/icinga/icinga2.git (fetch)
-upstream https://github.com/icinga/icinga2.git (push)
-upstream HEAD to own repository master branch to sync developmentHEAD is the default branch for this repository, usually master
-Example:
- -$ git checkout master
-$ git fetch upstream
-$ git pull upstream HEAD
-$ git push origin master
-Objective:
- -Steps:
- -$HOME/training
-feature/docs-merge-request
-README.md, add, commit and push the changestig
-
-If you are using GitHub/GitLab repositories, use forking and pull/merge requests.
- -Smart adoptions of the Gitflow workflow could include the following:
- -master)support/<version>)master branch
-The git rebase command can also be used to perform certain
-actions on a specific commit history.
If you are contributing to open source projects developers
-might ask you to either rebase your history or even squash
-all commits into one commit.
commit1 => commit
-commit2
-commit3
-Ask the trainer to draw an image for better illustration and discussion.
- - -
-git rebase -i HEAD~3 to start the interactive mode. HEAD~3 takes the last 3 commits compared to current HEAD.pick for the top commitpick with squash for the other commitsgit log to verify the historygit push -f and explain what happensgit rebase can also be used to edit the commits in your history.
-This is helpful if you want to amend changes to the test commit. Or if
-they are missing issue references, or just contain wrong information.
This is a common scenario for code reviews before merging the actual -history into the development branches.
- -
-You have learned that you can create remote (feature) branches. But what if -you want to delete such branches?
- -git push origin <branch> is short for git push origin <localbranch>:<remotebranch>.
Pushing NULL into a remote branch will delete it.
git push origin :<remotebranch>
Hint: You can delete branches in GitLab/GitHub too.
- - -
-$HOME/training
-feature/docs-wrong-name
-
-
-
-
-
-Server-side hooks receive the arguments through STDIN in the following -format:
- -oldref newref refname
-Example:
- -aa453216d1b3e49e7f6f98441fa56946ddcd6a20 68f7abf4e6f922807889f52bc043ecd31b79f814 refs/heads/master
-Example for a simple post-receive demo hook:
- -``` -$ vim post-receive
- -read line -set -- $line
- -num=$(git log --pretty=oneline ${1}..${2}| wc -l)
- -echo "New ref name '${3}' created. Pushed ${num} commits. Old ref '${1}' to new ref '${2}'." -exit 0
- -$ chmod +x post-receive -```
- -Test on the client:
- -``` -$ whoami -$ cd $HOME/training.git -$ echo "1" > hooktest -$ git add hooktest -$ git commit -av -m "1. hooktest" -$ echo "2" >> hooktest -$ git commit -av -m "2. hooktest"
- -$ git log -$ git push -... -remote: New ref name 'refs/heads/master' created. Pushed 2 commits. Old ref ... to new ref ... . -```
- -
-Reference example (German): https://blog.netways.de/2016/06/29/gitlab-webhooks/
- -Travis CI does not integrate well with GitLab, they prefer GitHub.
- -Jenkins builds with web books: https://github.com/jenkinsci/gitlab-plugin/wiki/Setup-Example
- -Rocket.Chat web hook integration: https://rocket.chat/docs/administrator-guides/integrations/gitlab/
- -Official GitLab Slack integration: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/user/project/integrations/slack.md
- -Both Rocket.Chat and GitLab are available at NWS:
- - - -
-r10k is a toolset provided by Puppet for deploying environments and modules.
+Reference blog post (German): https://blog.netways.de/2014/11/07/git-workflow-bei-puppet-mit-r10k/
- -Puppet environments and r10k are part of the "Scaling Puppet" training: -https://www.netways.de/en/events_trainings/puppet_trainings/scaling_puppet/
- -
-$ cd $HOME/training
-
-
$ cd $HOME/training
-References:
+$ git branch feature/docs masterhttp://blog.atom.io/2014/03/13/git-integration.html -http://blog.atom.io/2017/05/16/git-and-github-integration-comes-to-atom.html
+
-$ git branch
+* master
+ feature/docs$ git checkout feature/docs
+$ git branch
+ master
+* feature/docs
git checkout -b creates a new branch from the current branch
+and does the checkout afterwards. That way you'll safe some time
+when working with branches quite often.
$ git checkout master
+$ git checkout -b feature/docs2Open Source Training
+by NETWAYS (netways.de)
Reference: https://www.jetbrains.com/help/idea/using-git-integration.html
-
+
References:
+
-$ cd $HOME/training
-
-$ git branch -d feature/docs2$ git checkout master
+$ git branch -d masterOpen Source Training
+by NETWAYS (netways.de)
+
-
-$ cat .travis.yml
+Example
-language: php
+$ cd $HOME/training
-php:
- - '7.1'
-
-branches:
- only:
- - master
-
-script:
- - php phpunit.phar -c modules/test/phpunit.xml --verbose
-
+@@@ Sh
+$ git show HEAD^or
+$ git show HEAD~1
Adding Jenkins to your Git workflow requires additional toolsets.
+A Git hook configured on the git server is able to trigger a Jenkins job. -It passes the git commit id to the Jenkins job which runs a local git checkout -and further job actions afterwards, for example tests and/or package builds.
+$ git checkout master
+$ git checkout -b feature/dpcsVice versa a Jenkins build job hook needs to update the ticket system. This will -notify the user of an unsuccessful run immediatly allowing further actions.
+The issue id can be for example passed from the git hook into the Jenkins job. -This requires strict rules on git commits - a git commit without any referenced -issue id will destroy this workflow.
+$ git checkout masterDefine and document a git commit format specification and enforce this -to your users. In addition to that install a git hook on the server -which rejects a git push when the commit is missing an issue id.
+
-$ git show feature/docs$ echo "I understand HEAD now" >> README.md
+$ git add README.md
+$ git commit -v README.md -m "What I've learned so far: HEAD"$ git diff HEAD feature/docsDocumentation: https://docs.gitlab.com/ce/ci/README.html
- -Reference example (German): https://blog.netways.de/2017/05/03/gitlab-ce-continuous-integration-jobs-and-runners/
-
+
.gitlab-ci.yml configuration file in Git repositorygit push
-Documentation references:
- -https://docs.gitlab.com/ce/user/project/container_registry.html
- -
-
-gitlab-runner registerNote: This is not needed for the built-in docker executor runner.
Open https://nws.netways.de in your browser and register your +personal account. Login and navigate to Apps > GitLab CE > Basic +and deploy the app.
+Use Live View and set a secure root password. The login into GitLab.
+Open Source Training
+by NETWAYS (netways.de)
Documentation References:
- -https://docs.gitlab.com/runner/install/linux-repository.html -https://docs.gitlab.com/runner/register/index.html
-
+
```
+GitLab 10.x provides New Project underneath the + icon
+in the top menu bar, next to the search form.
Fill in the Project name form with training and leave the
+other options as default.
registry_external_url 'https://gitlab.example.com:5000'
+You'll notice the HTTPS URL centered below the project name.
```
+We will be using this remote URL for connecting our local repository +in the next step.
-Documentation References:
+Right now the repository is empty and does not contain any file. +GitLab offers you to add new files, e.g. a README.md file or LICENSE details +directly in the browser. In the background, it is still comitting +the changes to the Git repository.
-https://docs.gitlab.com/ce/user/project/container_registry.html -https://docs.gitlab.com/ce/administration/container_registry.html -
+
+
$ git config --global --get credential.helper
+/usr/libexec/git-core/git-credential-gnome-keyringDocumentation References:
+If not set, you can set it explicitly.
- +$ git config --global credential.helper /usr/libexec/git-core/git-credential-gnome-keyring
Documentation References:
+https://docs.docker.com -https://docs.gitlab.com/runner/install/docker.html
+$ cd $HOME/training.git
+$ git remote add origin https://[...].nws.netways.de/root/training.git
+$ git fetch$ git pushThis will not work since the local branch does not follow the remote branch.
+Use --set-upstream as proposed by the cli output. Short form is -u.
$ git push --set-upstream origin masterGit versions prior 2.0 did not define the default push method. The default behaviour +was to use the same local branch name for the remote branch name.
+The new default method should be simple which ensures that the local branches
+will only be pushed to remote branches which git pull is following.
Our setup did not clone the repository (which includes a virtual git pull). Therefore +the local master branch does not follow a remote branch.
-In order to fix that, add the default push method to your global configuration.
-Reference: https://gitlab.com/gitlab-org/gitlab-runner/blob/master/docs/install/linux-repository.md
+git config --global push.default simpleimage as container base imageservices which should be runningall_tests as job nameExample:
+image: alpine:latest
+
-all_tests:
- script:
- - exit 1
-Choose History and look at the Git commits, their author, subject and timestamp.
Compare it with the local git log or tig entries.
Documentation References:
+https://about.gitlab.com/2016/03/01/gitlab-runner-with-docker/
+
-$ cd $HOME/training
+$ git checkout master
-
-- Objective:
+$ vim README.md
-
-- Create CI configuration for the training project
-
-
-- Steps:
+Now I know how to publish my changes to my NWS hosted GitLab server.
-
-- Create the
.gitlab-ci.yml file in the training directory (vim, nano, etc.)
-- Add
image: alpine/latest to specify base image
-- Add job
all_tests with script as array element, which itself runs exit 1
-
-
-
-
+$ git add README.md
+$ git commit -v README.md -m "Add docs for git push"$ git push origin mastergit add .gitlab-ci.yml and commit the changeCI / CD and verify the running job0, add, commit, push and verify again$ git log
+$ git reset --hard HEAD^
+$ git log$ git fetchCompare this with your local commit history - you'll see that there are +not changes pulled yet.
+ +$ git log$ git pullCheck the local commit history - now your local history has been +updated with the remote history.
+ +$ git log$ git log
+$ git tag -m "Release v0.1" v0.1Documentation References:
+$ git tag -lhttps://docs.gitlab.com/ce/ci/README.html#examples
+https://gitlab.com/gitlab-org/gitlab-ci-yml
+$ git push --tags.gitlab-ci.yml and add a before_script section after the image sectionapk package manager and install python and py-pip packagespip to install the markdown and Pygments librariesExample:
+before_script:
- - apk update && apk add python py-pip
- - pip install markdown Pygments
-$ cd $HOME/training
+$ vim README.md
+Now I am learning how to use git stash and temporarily drop the changes
+e.g. to change into another branch.$ git statusThe base image uses Alpine Linux which has a very small installation size -and footprint.
+$ git stash
+Saved working directory and index state WIP on master: 31dcde5 Add docs for git push
+HEAD is now at 31dcde5 Add docs for git pushIn contrast to the "typical" Linux distribution containers, this allows for -faster tests and deployment scripts.
+If your build pipeline involves specific distributions, choose the best and -reliable container distribution you prefer.
+$ git status
+On branch master
+nothing to commit, working tree cleanAlpine uses its own package manager. This exercise installs
+pip
-$ git stash list
+stash@{0}: WIP on master: 31dcde5 Add docs for git push
+
+@@@ Sh
+$ git stash show -p
+
+diff --git a/README.md b/README.md
+index 2081a37..550db95 100644
+--- a/README.md
++++ b/README.md
+@@ -15,3 +15,7 @@ Now for real.
+ ```
+ git commit --amend
+ ```
++
++## Git Stash
++
++`git stash`Reference: https://wiki.alpinelinux.org/wiki/Alpine_Linux_package_management
+$ git stash pop
+
+Dropped refs/stash@{0} (a9f28340e6d536a9179307bd26169368e450161f)markdown and use script to generate README.html
-archifacts with paths pointing to README.html. Expires in 1 week
-README.html file in your browserExample:
+markdown:
- script:
- - python -m markdown README.md > README.html
- artifacts:
- paths:
- - README.html
- expire_in: 1 week
-The last parameter specifies the target directory training1.
$ cd $HOME
+$ git clone https://[...].nws.netways.de/root/training.git training1$ echo "My Name" > AUTHORS$ git add -A .
+$ git commit -av -m "Add myself to AUTHORS"$ git push origin masterREADME.md
-README.html file in your browserThe last parameter specifies the target directory training2.
$ cd $HOME
+$ git clone https://[...].nws.netways.de/root/training.git training2Code => Build => Test => Deploy
+$ git reset --hard HEAD~2$ vim README.md
-Reference: https://docs.gitlab.com/ce/ci/pipelines.html
+Testing rebase
-
$ git fetch
+$ git diff origin/masterRebase your local history against the remote origin master branch.
-$ git rebase origin/master$ git status
+$ vim README.mdSearch for conflicts in vim:
+ +/>>>
+Resolve the conflicts, add the file and continue the rebase.
+ +$ git add README.md
+$ git rebase --continue$ git push origin master
+The new branch feature/docs-workflows will be based on the master branch.
-$ cd $HOME/training
+$ git checkout master
+$ git checkout -b feature/docs-workflows-v
---dry-run
-$ vim README.md
+## Workflows
+Central Workflow and now feature workflows with descriptive branch names.
-
-$ git push -u origin feature/docs-workflowsgit bisect
+git blame
+git grep
+$ cd $HOME/training
+$ git checkout feature/docs-workflows
+$ vim README.md
+
+I'm learning about workflows today.
+
+$ git add README.md
+$ git commit -v README.md -m "Update docs for workflows"
+$ git push origin feature/docs-workflows$ git branch
+$ git checkout feature/docs-workflows
+$ git diff master feature/docs$ git checkout master
+$ git merge --no-ff feature/docs-workflows
-
+In this commit message, I may add a reference to a GitLab issue like this
+to automatically resolve it after merge.
-git bisect can be used to invoke a binary search to find the commit that introduced a bug.
+fixes #12git blame prints a file and each line changed by the latest commit and author.
git grep prints all lines from the commit history matching a pattern.
$ tiggit blame
-git blame filename
-$ cd $HOME/training
+$ git checkout master
+$ git checkout -b feature/docs-merge-request
+$ vim README.md
+
+Let's create a merge request with GitLab.
+
+$ git add README.md
+$ git commit -v README.md -m "Update docs for merge requests"
+$ git push -u origin feature/docs-merge-requestGitLab puts the URL into the shell output on pushing the branch.
+ +$ git push -u origin feature/docs-merge-request
+Counting objects: 6, done.
+Delta compression using up to 4 threads.
+Compressing objects: 100% (6/6), done.
+Writing objects: 100% (6/6), 618 bytes | 618.00 KiB/s, done.
+Total 6 (delta 4), reused 0 (delta 0)
+remote:
+remote: To create a merge request for feature/docs-merge-request, visit:
+remote: https://[...].nws.netways.de/root/training/merge_requests/new?merge_request%5Bsource_branch%5D=feature%2Fdocs-merge-request
+remote:
+To https://[...].nws.netways.de/root/training.git
+ * [new branch] feature/docs-merge-request -> feature/docs-merge-request
+Branch 'feature/docs-merge-request' set up to track remote branch 'feature/docs-merge-request' from 'origin'.Open the URL in your browser.
+ +Specify a topic, description and create the merge request.
+ +Merge the request to master and investigate the Git history.
+ +$ git checkout master
+$ git pull
+$ tigIf you do not have any.
+ +$ git checkout master
+$ git checkout -b feature/squash-test
+
+@@@ Sh
+$ echo "# Rebase and Squash" >> README.md
+$ git commit -av -m "commit1"
+$ echo " " >> README.md
+$ git commit -av -m "commit2"
+$ echo "`git rebase -i` is interactive" >> README.md
+$ git commit -av -m "commit3"This is where git rev-list comes in handy.
Use the interactive mode by specifying the -i parameter.
+HEAD~3 uses the commit range three commits to the current
+HEAD commit.
Find the last commit which affected the given path.
+$ git rebase -i HEAD~3git rev-list -n 1 HEAD -- <filepath>.
The interactive mode opens the editor you are familiar with +from commit messages.
-Then checkout the version at the commit before using the caret ^ symbol.
git checkout <deletingcommit>^ -- <filepath>
pick 5a31d9e commit1
+squash ce90e16 commit2
+squash ed6a68f commit3Manually apply and create Git patches.
+git apply: apply git patchgit am: read patches from STDIN and apply themgit format-patch: create git patchIf you do not have any.
-$ cd $HOME/training
+$ git checkout master
+$ git checkout -b feature/docs-wrong-name
+$ git push -u origin feature/docs-wrong-name$ git branch -r
+ feature/docs-wrong-namegit apply applies a git patch file to your working tree.
git am reads git patches from your mailbox by default. It also can be used to
-read patches from the shell's STDIN (e.g. curl downloading a patch from the web).
-The -s option allows you to sign off the patch, for example if you have reviewed
-the patch from an external committer.
$ git push origin :feature/docs-wrong-namegit format-patch requires either a negative number of commits from current HEAD or
-a git commit id. It will then create numbered patch files for all required commits.
Now verify it is gone (Hint: -r lists remote branches).
$ git fetch
+$ git branch -rNavigate to /admin/runners.
+How to setup a shared Runner for a new project
+Install a Runner compatible with GitLab CI (checkout the GitLab Runner section for information on how to install it).
+Specify the following URL during the Runner setup: ...
+Use the following registration token during setup: ...
+Start the Runner!
+
-Registered runners are listed at the bottom.
-$HOME/.gitconfig file[alias] section if not existingd as an alias for diff
+gitlab-runner register as roottraining01 and tag training
+true, Lock to current project: false
+docker, Default: alpine/latest
Reference: https://gitlab.com/gitlab-org/gitlab-runner/blob/master/docs/install/linux-repository.md +Reference: https://docs.gitlab.com/runner/install/linux-repository.html
+ +Reference for Docker: https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/
+ +Example on Ubuntu:
+ +``` +apt-get install \ + apt-transport-https \ + ca-certificates \ + curl \ + software-properties-common
+ +curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
+ +add-apt-repository \ + "deb [arch=amd64] https://download.docker.com/linux/ubuntu \ + $(lsb_release -cs) \ + stable"
+ +apt-get update +apt-get install docker-ce +```
+ +
+curl -L https://packages.gitlab.com/install/repositories/runner/gitlab-runner/script.deb.sh | sudo bash
+apt-get install gitlab-runner
+
Start CLI
+ +# gitlab-runner register
+Running in system-mode.
+
+Please enter the gitlab-ci coordinator URL (e.g. https://gitlab.com/):
+http://192.168.56.101
+
+Please enter the gitlab-ci token for this runner:
+Do1aqTvPiiBj6_u_u5Ye
+
+Please enter the gitlab-ci description for this runner:
+[ubuntu-16]: training01
+
+Please enter the gitlab-ci tags for this runner (comma separated):
+training
+
+Whether to run untagged builds [true/false]:
+[false]: true
+
+Whether to lock the Runner to current project [true/false]:
+[true]: false
+Registering runner... succeeded runner=Do1aqTvP
+
+Please enter the executor: docker+machine, docker-ssh, parallels, ssh, virtualbox, docker, shell, docker-ssh+machine, kubernetes:
+docker
+
+Please enter the default Docker image (e.g. ruby:2.1):
+alpine:latest
+
+Runner registered successfully. Feel free to start it, but if it's running already the config should be automatically reloaded!Example:
+$ vim .gitattributes
+
-modules/** eol=lf$ cd $HOME/training
+$ vim .gitlab-ci.yml
+image: alpine:latest
-
-The script will always fail. We will use different exit states to fix it. +Future examples and tests work the same way.
+
+
.git repositoryExample:
+$ git submodule add https://github.com/Icinga/puppet-icinga2
-$ git status
- new file: .gitmodules
- new file: puppet-icinga2
+
-$ git submodule
- ad5e309... puppet-icinga2 (heads/master)
-Fresh clone:
+$ git add .gitlab-ci.yml
+$ git commit -av -m "Add GitLab CI config"
+$ git push origin master$ git clone --recursive ...
+Modify exit code
-$ git clone ...
-$ git submodule init && git submodule update
-$ vim .gitlab-ci.yml
+image: alpine:latest
+all_tests:
+ script:
+ - exit 0Note: Git submodule removal is not trivial.
+https://davidwalsh.name/git-remove-submodule
+
-$ vim .gitlab-ci.yml
-
-- Merge an external git repository history
-- Directory in your main repository (
--prefix)
-- Squash the remote history into one commit
-- No external dependency (e.g. git submodule repository not available anymore)
-- No local configuration - document the external reference
-
+image: alpine:latest
-Example for imported Puppet modules:
+before_script:$ git subtree add --prefix modules/icinga2 \
-https://github.com/Icinga/puppet-icinga2 HEAD --squash
+Update apk and install Python/pip
-$ git subtree pull --prefix modules/icinga2 \
-https://github.com/Icinga/puppet-icinga2 HEAD --squash
-$ vim .gitlab-ci.yml
+image: alpine:latest
+before_script:
+ - apk update && apk add python py-pip$ vim .gitlab-ci.yml
-Adding a git subtree requires
+image: alpine:latest
-
-- Existing directory tree except for the one created
-- Git clone URL
-- The branch which should be added (use
master as default)
-- Optionally
--squash all commits into one
-
+before_script:
+ - apk update && apk add python py-pip
+ - pip install markdown PygmentsExample:
+git subtree add --prefix clippy.js https://github.com/smore-inc/clippy.js.git master --squash
-$ vim .gitlab-ci.yml
-$ git commit -av -m "CI: Prepare markdown conversion"
+$ git push$ vim .gitlab-ci.yml
-
-- Default Settings
-- Stats, Versions, Users
-- Permission Management
-- Monitoring, System Hooks
-- Appearance and Customizing
-
+...
-Explore this with the trainer and discuss specific topics.
+all_tests:
+ script:
+ - exit 0
+markdown:$ vim .gitlab-ci.yml
-
+...
-Add paths section which includes README.html as entry.
+Tell GitLab to expire this artifact in 1 week.
$ vim .gitlab-ci.yml
+...
-
-$ vim .gitlab-ci.yml
-Secure HTTPS environment
+image: alpine:latest
-
-- Use Let's Encrypt or own certificates
-- Enable HTTPS in GitLab/Nginx
-- Forward all HTTP requests to HTTPS
-
+before_script:
+ - apk update && apk add python py-pip
+ - pip install markdown Pygments
+all_tests:
+ script:
+ - exit 0
+markdown:
+ - python -m markdown README.md > README.html
+ artifacts:
+ paths:
+ - README.html
+ expire_in: 1 weekReference: https://docs.gitlab.com/ce/install/installation.html#using-https
+$ git commit -av -m "CI: Generate HTML docs from Markdown"
+$ git pushNavigate into the repository > CI / CD > Jobs > #... and choose Job Artifacts.
+Download them, extract them and open the HTML file with your browser.
+
vim README.md
-git commit -av -m "Add notes on CI runners"
+git pushNavigate into the repository > CI / CD > Jobs > #... and choose Job Artifacts.
+Download them, extract them and open the HTML file with your browser.
+
You can manage nearly everything.
+$ git blame README.mdReference: https://docs.gitlab.com/ce/api/README.html
+$ echo "Blame me" >> README.md && git commit -av -m "Blame me"
+$ echo "Blame me, too." >> README.md && git commit -av -m "Blame me, too"
-API Clients: https://about.gitlab.com/applications/#api-clients
+$ git blame README.mdGitLab provides an extensive list of external applications:
+https://about.gitlab.com/applications/
+$ vim $HOME/.gitconfig
-
-Reference: https://docs.gitlab.com/ce/api/README.html
+$ vim AUTHORS
+:dd
-API Clients: https://about.gitlab.com/applications/#api-clients
+$ git d