> For the complete documentation index, see [llms.txt](https://hanfak.gitbook.io/workspace/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hanfak.gitbook.io/workspace/version-control.md).

# Version Control - Git

I have mainly been using Git to version control all software that has been worked on. There are some legacy projects that has used 'Subversion' but these have been migrated to Git.

## Commands

* add
* commits
  * messages inline
  * via terminal text editor ie vim
    * common vim controls
      * <https://stackoverflow.com/questions/6098742/using-git-commit-a-with-vim>
* shelf & unshelf
* Tag
* revert
* reset
* diff
* logs/history
* push
  * all branches
* pull
* fork
* clone
* fetch
* patch
* stash
* unstaged files
  * if dont want them committed, they are unadded, so can delete them
* Remove changes to file
  * 'git checktout -f '
* Files that have changes, but dont want them commited
  * intellij can put to another changeset
  * can stash them
* branch
  * checkout
* merge
* rebase
* cherry pick
* mv
  * When you need to rename a folder and keep the history of all the files inside
  * `git mv <source> <target>`
  * need to commit after doing this
* submodule
  * Have a separate repo inside another repo

### Tips

To change anything, instead of changin git config via the command line commangs, can alter the file in /.git/config

### Links

* [Git Documentation](https://git-scm.com/doc)
* <https://www.tutorialspoint.com/git/index.htm>
* <https://examples.javacodegeeks.com/software-development/git/popular-git-commands-examples/>
* Tutorial
  * <https://git-scm.com/docs/gittutorial>
  * <https://www.atlassian.com/git/tutorials>
  * <https://try.github.io/levels/1/challenges/1>
  * <https://github.com/enkidevs/curriculum/wiki/Git-Topic>

## Trunk and feature based development

* <https://www.javacodegeeks.com/2018/12/improve-proces-trunk-based-development.html>
* <https://medium.com/@mattia.battiston/why-i-love-trunk-based-development-641fcf0b94a0>

## Git In Intellij

Most of my git usage is done via Intellij. Here are some common uses and tips:

* When a new project has been created, need to set up git. Two ways to do This
  * command line
    * In command line, go into folder of project
    * type `git init`
  * IntelliJ
    * Go to menu \`VCS > Enable Version Control Integration'
    * select `Git` from drop down in popup menu
    * At the top of editor window sign saying `Missing .gitignore file ...` click `Create .gitignore`
      * In the popup menu, search for the language and tick it and click `Generate`
    * A popup `Add files to Git` will have all files ticked, this will add them to your commits.
      * Any files belonging to Intellij, ie `.xml` apart from the pom, and `.idea` folder can be unticked. As these dont need to be part of your project.
      * Make sure the `.gitignore` file is ticked
      * After making your chocie click finish.
    * Add the rest of files.
      * Go to `9. Version Control` tool window (shortcut alt + 9) then click and drag all the files you want to commit from the `Unversioned Files` into the `Default` section.
      * These should really only be the `pom.xml` and any files ending with `.java`
* Adding new file
  * If you create a new file that is meant to be part of the project, then a popup will ask you if you want to `add file to git`. Click `yes` if you want to.
  * IF you clicked no but really wanted to click yes, or viceversa, just right click on specific file or files, navigate to `git > revert` to remove being considered for a commit. Or if you want to add it navigate to `git > add`
* shortcuts (unix)
  * ctrl + k = commit
  * F7 or alt + left/right = go through changes
  * ctrl + shift + k = push
  * alt + ??: To access Version control window
* On commit screen, click on optimise imports on right hand side
  * can do ctrl + alt + o when in a particular file
    * There is a link (see pic) where you can see prior commits (commit message history ctrl + m ), great if need to see history of commits or copy commit messages
* All the files ticked which need to be added
  * Can untick files not to be part of commits
    * Be careful, as when close commit window and bring it up it will select all added files for commit
* Use `revert` on a file if need to undo all changes back to last commit instead of lots of undos
* Use shelf to save changes in case need to do another design or fix a bug
* In version control window > local changes, can move files from different default changeset (which will commited ) to another change set
* In version control window > log, great place to do searching through history of commits, view files that were commited, view diff of files with current file or another previous commit
  * Great to see visual representation of branches and where they were merged
  * To make full use of this feature, good to have a naming strategy for commits
    * ie `<Story number> <developers working on commit> description of changes in commit`
  * Can create branches, revert, reset, checkout branches
* Make use of patches, help to save changes in file, and can be passed to different machines or saved for when story mgiht be played at later date as it has been put on hold.
  * best to use name of patch as the same as the commit message
  * Can also turn shelf into a patch
    * In version control window > Shelf section
* Use of VCS > local history
  * Great for going through multiple changes that have been made

## Git Repository

* Types
  * Github
  * Gitlabs
  * Bitbcket (little experience)
* Remote
  * Delete
  * Add
  * view all remotes
* Permissions
* Create project/repo
* Connecting via
  * SSH
  * Https
* README.md
  * Creating Documentation
  * writing in markdown
  * <https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet>
  * <https://dbader.org/blog/write-a-great-readme-for-your-github-project>

### Links

* <https://guides.github.com/introduction/flow/>
* <https://guides.github.com/>
* <https://help.github.com/>

## Continuous Integration

How work is integrated into shared repository

* Types
  * Master branch (current way)
    * General format
      * Make sure repo is up to date (git pull and rebase)
      * work on Master
      * When commiting, run full build and test suite
      * When green commit and push
        * If there is a new commit to pull, cannot push with out pulling
        * Need to merge changes into local, get passing build and push
          * Normally work on stories that are on separate parts of same code base, but different pairs would work on different apps so no merge issues
      * <https://stxnext.com/blog/2018/02/28/escape-merge-hell-why-i-prefer-trunk-based-development-over-feature-branching-and-gitflow/>
      * <https://trunkbaseddevelopment.com/>
  * Branching for each user story
    * General format
      * create branch from master
      * add commits for this story
      * Make pull request when story is completed
      * Code is reviewed and changes takes place (code review)
      * Merge branch with master
    * When Used
      * no pairing takes place thus reviewing code is a must
* Merging
  * After merging, from remote and local. You will need to fix merge conflict and then rerun the build, before pushing
* What should go in to version control
  * All app code and dependencies
  * scripts that create database, environments
  * Automated and manual tests
  * scripts that suppoort code packaging, deployment, db migrations, environment provisioning,
  * Configuration files for environments and applications

    \-

### Links

* <https://www.thoughtworks.com/continuous-integration>
* <https://martinfowler.com/bliki/FeatureBranch.html>
* <https://martinfowler.com/articles/continuousIntegration.html>
* Tutorial
  * <https://learngitbranching.js.org/>
  * <https://www.atlassian.com/git/tutorials/using-branches>
  * <https://docs.microsoft.com/en-us/vsts/git/tutorial/gitworkflow?view=vsts>

    \-

## Migrating to Git