USING GIT FOR AUTOMATION AND COLLABORATION JUSTIN ELLIOTT - MATT HANSEN PENN STATE UNIVERSITY

Size: px

Start display at page:

Download "USING GIT FOR AUTOMATION AND COLLABORATION JUSTIN ELLIOTT - MATT HANSEN PENN STATE UNIVERSITY"

Carol Henry
6 years ago
Views:

1 USING GIT FOR AUTOMATION AND COLLABORATION JUSTIN ELLIOTT - MATT HANSEN PENN STATE UNIVERSITY

2 AGENDA Version control overview Introduction and basics of Git Advanced Git features Collaboration Automation

3 VERSION CONTROL

4 WHAT IS IT? Manages changes and versions of files Also known as: Source Code Management (SCM) Version Control System (VCS) GitHub is a hosting service that uses Git

5 WHY USE IT? Reduces risk and enables you to experiment with code Agility Flexible workflows Quicker deployments Automate updates

6 WHY USE IT? Helps with documentation Collaboration with others Contributing to open source projects Modifying a project for your own use

7 GIT INTRODUCTION

8 WHY GIT? The current de facto standard for source code management Easy to learn, quick to start! Very powerful and extensive

9 GIT OVERVIEW Extremely fast Excellent data integrity Git checksums everything (SHA-1)

10 GIT OVERVIEW Distributed All clients have the full repo Backups are everywhere Local repo updated before remotes When available, push updates to remote

11 GIT TERMINOLOGY Repository Local Remote Working Directory Commit

12 GIT INSTALLATION & CONFIGURATION

13 H O W T O I N S TA L L G I T Embedded with many Git GUI Apps Included with XCode Download from OS X: Terminal.app Windows: Git Bash Linux: Terminal OS X: MacPorts and HomeBrew

14 GIT CLIENT APPS GitHub Desktop SourceTree

15 REVIEWING DIFFS Very easy to view with GitHub Desktop and Web External diff apps FileMerge Kaleidoscope

16 GITHUB DESKTOP Simplifies the complex Git tasks Integrates well with GitHub hosting service Easy to start with Limited feature set (by design)

17 DEMO: GITHUB CONFIG

18 CONFIGURING GIT ON THE CLI Git GUI clients handle it for you, or for the CLI fans $ git config Contains items such as name, , editor, diff tool Critical for collaboration

19 DEMO: GIT CONFIG CLI

20 FUNDAMENTALS

21 REPO FILE CLASSIFICATIONS Tracked Ignored Untracked

22 TRACKED FILE STATES Modified Staged GitHub Desktop shows as checkboxes Committed

23 CREATE A REPO Create new empty project repository Working Directory

24 ADD FILES TO THE REPO Add (stage) files for the next commit Working Directory add Staging Area

25 COMMIT FILES TO REPO Save staged files to the project repository Working Directory add Staging Area commit Repository

26 COMMITS Saves file changes to the repo Each commit should encapsulate a single fix* Commit often - You will thank yourself later! Or else Larger changes are much harder to pick apart and revert back to.

27 IGNORING FILES / DIRECTORIES Why? What? How? Scope Single Project Repo All Repos ( Global ~/.gitignore_global file ) Recommended to create ignore file as first step

28 COMMIT HISTORY LOGS Review history of commits to repo Documents changes over time Extremely helpful for your future self and others

29 DEMO Create repo Modify same tracked file Create files View diff of file changes Show status Commit the file Ignore file(s) Review history log Commit git ignore file Revert to previous commit Initial commit of file Review history log

31 BRANCHES

32 BRANCHES Provide separate paths of code development When should they be used? Others to help test before merged to master master is the default branch Great for vetting major changes, for others to review Many workflow methods out there (ie, GitFlow)

33 BRANCH WALK THROUGH First Commit M1

34 BRANCH WALK THROUGH M1 B1 New Branch

35 BRANCH WALK THROUGH M1 B1 B2 Second Branch Commit

36 BRANCH WALK THROUGH M1 B1 B2 B3 Third Branch Commit

37 BRANCH WALK THROUGH M1 B1 B2 B3 B4 Fourth Branch Commit

38 BRANCH WALK THROUGH Merge Branch To Master M1 M2 B1 B2 B3 B4 (Branch Deleted After Merge)

39 GIT'S "HEAD" REFERENCE Reference pointer to a commit Detached HEAD warning What does it mean? When does this occur? What should I do? Have code changes? Branch!

40 BRANCH WORKFLOWS GitHub Flow Atlassian s List Centralized Feature Git Flow Forking

41 REMOTES

42 REMOTES Local repo on your client only Remote is a Git host to push to You clone from remote(s) ie. GitHub, BitBucket First remote is called origin Avoid changing the remote name, some GUI Apps look for it

43 REMOTE REPOS Network Protocols HTTPS SSH (Keys) Git Protocol (daemon)

44 SELF-HOSTED REPO SERVICES SSH Enable SSH, create bare repository on server % git init --bare --shared Atlassian Stash Enterprise GitHub GitLab

45 HOSTED REPO SERVICES GitHub, BitBucket SourceRepo, Assembla GitLab git.psu.edu for Penn Staters (runs on GitLab) And many more

46 GIT WORKFLOW STAGES Working Directory add Staging Area commit Repository pull push Remote

47 CLONING Copies repo from remote Repo includes entire project

48 PUSHING Saves commits to remote server Pushes active branch that you re on

49 FETCHING Updates repo status of remote Local repo files are not changed Always fetch or pull before pushing to remotes!

50 REMOTES - DO'S AND DON'TS Do... Always fetch or pull before making changes Don't... Otherwise you will need to merge or rebase your changes Make changes to local repo before fetching/pulling, or else create a new branch first OR stash the files first

51 REMOTES DEMO Add local repo to GitHub Desktop Publish to GitHub View new remote host via git remote -vv View tracking branch(es) via git branch -vv Local branches track remote branches Commit first to local, then push to GitHub Create README.md file on GitHub, Pull

53 COLLABORATION

54 ETIQUETTE Pull Request vs. Feature Requests Read the project's docs and guidelines first Start with simple changes to learn processes Avoid pull requests on pull requests Instead, provide feedback to author of pull for additional fixes or suggestions

55 ETIQUETTE Commit Messages Keep them small, clear and descriptive Remember others need to understand them Stick to the project's coding styles and conventions Follow or establish team decided branch workflow Be nice!

56 CREATING A PULL REQUEST Their Remote Repo Contributor fork Your Remote Repo merge push clone/pull Local Repository commit Pull Request Working Copy Discussion

57 GITHUB PULL REQUEST

58 RECEIVING A PULL REQUEST Discuss and gather feedback

59 RECEIVING A PULL REQUEST Squash & merge or Merge commit

60 RECEIVING A PULL REQUEST Checkout and test

61 AUTOMATION

62 INTEGRATIONS Automatic s Push notifications Slack Channels, IRC, Twitter, HipChat, etc. Methods WebHooks Agents / Runners Polling

63 AUTOMATION TOOLS Scripts launchd, cron to automate git pulls AutoPkgr schedule for autopkg recipe repos Continuous Integration Jenkins, Atlassian Bamboo, GitLab Travis CI

64 WEBHOOKS Receive event notifications between multiple systems commit, push (tag or branch), releases, issues, documentation updates, forks, etc. Useful for updating, notifying, building, testing, backing up, deploying

65 AUTOMATION IDEAS Auto update servers (Web, etc.) Revert to previous commit Example Agent/Runner runs script after repo receives commit Automated testing, build and test products/recipes

66 AUTOMATED WORKFLOWS Update server content from master branch Auto pull ready for production versions Track changes made on servers, switches.git folder security issue - be aware

67 CLC CASE STUDY GitLab GitHub autopkg Jenkins Slack BigFix

68 CLC CASE STUDY Lessons Learned Use the tool that works best Keep it simple and robust Lots of notifications, categorized and specific Working with internal and external collaborators Leverage the features of Git - commits, events, builds

69 SUMMARY

70 LESSONS LEARNED Start small Pick just one project to manage with Git Use remotes when ready GitHub, BitBucket Your own SSH host

71 LESSONS LEARNED Write good commit messages There will be a time when you need to search your commit messages and it will really help you out! Be nice to your future self. Where / when / how did I fix that issue? What s for the release notes?

72 LESSONS LEARNED Keep it simple Don't be afraid to experiment Automation and integrations are powerful Use them after you're comfortable with the basics

73 RESOURCES AND TRAINING Official Git Site Git Cheat Sheets Git Pro Book bit.ly/psumac-nice-pulls

74 RESOURCES AND TRAINING - learn Git in 15 minutes! O Reilly McCullough and Berglund on Mastering Git

75 Q & A Justin Elliott jelliott [at] Matt Hansen hansen.m [at] Feedback:

GIT FOR SYSTEM ADMINS JUSTIN ELLIOTT PENN STATE UNIVERSITY

GIT FOR SYSTEM ADMINS JUSTIN ELLIOTT PENN STATE UNIVERSITY 1 WHAT IS VERSION CONTROL? Management of changes to documents like source code, scripts, text files Provides the ability to check documents in