Git hooks
Download as PPTX, PDF3 likes1,802 views
This document discusses using Git hooks to automate tasks during the Git workflow. It provides examples of using pre-commit hooks to check for debugging code and validate commit messages include ticket numbers. prepare-commit-msg hooks can template commit messages with default text like ticket references. post-commit hooks may open a browser to log work time against a referenced ticket after a commit. Server-side hooks on push can trigger tasks like running tests. Overall the document explores leveraging Git hooks for tasks like validation, templating, integration and to enforce best practices when committing code changes.
![Pre-commit -1
Before commit, this hook can check something for you.
For example, in my pc, I will check where the code has “binding.pry” or not.
Place: .git/hooks/pre-commit
Code:
#!/usr/bin/env ruby
require 'colorize'
# check for rails debugger
rails_result = `grep -rlsn "binding.pry" --exclude-dir=".git" .`
if rails_result != ""
puts "[Error] you put binding.pry in your filesn".red
puts rails_result
exit(1)
end](https://image.slidesharecdn.com/githooks-130511211055-phpapp02/85/Git-hooks-9-320.jpg)
![Prepare-commit-msg -2
• #!/usr/bin/env ruby
•
• TICKET_REGEXP = /[A-Z]+-d+/ # WEB-12345
•
• TICKET_REF_FORMAT = 'Ticket #%s # ' # JIRA Ticket reference syntax.
•
• branch_name = `git branch --no-color 2> /dev/null`[/^* (.+)/, 1]
• msg_filename = ARGV[0]
•
• if ticket_in_branch = branch_name.match(TICKET_REGEXP)
• ticket_ref = TICKET_REF_FORMAT % ticket_in_branch.to_s
• old_msg = File.read msg_filename
•
• unless old_msg.match ticket_ref
• File.open msg_filename, 'w' do |new_msg|
• new_msg.write ticket_ref + old_msg
• end
• end
• end
•
• exit 0](https://image.slidesharecdn.com/githooks-130511211055-phpapp02/85/Git-hooks-12-320.jpg)
![Commit-msg -1
• We can this hook to check whether your commit message has ticket number or not.
• #!/usr/bin/env ruby
•
• require 'colorize'
•
• TICKET_REGEXP = /[A-Z]+-d+/ # WEB-12345
•
• commit_message = File.open ARGV[0], 'r' { |f| f.read }
•
• unless commit_message.match(TICKET_REGEXP)
• puts "[ERROR] commit-message-format: JIRA ticket number is not existed.".red
• exit(1)
• end](https://image.slidesharecdn.com/githooks-130511211055-phpapp02/85/Git-hooks-14-320.jpg)
![Post-commit -1
If everything goes well, then we can open firefox to log your time.
• #!/usr/bin/env ruby
•
• require 'colorize'
•
• TICKET_REGEXP = /[A-Z]+-d+/ # WEB-12345
•
• LINK = "https://*****.atlassian.net/browse/"
•
• puts "[Warning] log time: Please do not forget to log your time".red
•
• commit_message = %x{git log -1 --abbrev-commit}.split("n").last.strip
•
• jira_ticket = commit_message.match(TICKET_REGEXP)
• puts "please visit #{LINK}#{jira_ticket.to_s} to log time".green
•
• exec("firefox #{LINK}#{jira_ticket.to_s}")](https://image.slidesharecdn.com/githooks-130511211055-phpapp02/85/Git-hooks-16-320.jpg)
Git hooks
- 2. Why ? Problem: Some guys forgot to log their working time. Therefore, for teamleaders, they can not know how this ticket going. Solution: After you git commit, open browser to log your working time.
- 3. How ? Git has one function named as hooks. ( http://git-scm.com/book ) In my words, Hooks like event trigger After you did git operation, it will trigger some events.
- 4. Examples Git checkout ----------> you want to check whether all gems have been installed. Git push ----------> you want to trigger jenkins server to run rspec to check you code.
- 5. Place • Git hooks is in .git/hooks • You can use shell script or ruby or python • But remember to use chmod +x filename
- 6. Types There has two types: Client side (In your local PC) Server side (In remote server like Stash) • applypatch-msg • post-update • pre-rebase • commit-msg • pre-applypatch • update • post-commit • pre-commit • post-receive • prepare-commit-msg
- 7. Git Commit When you use git commit : pre-commit ↓ prepare-commit-msg ↓ commit-msg ↓ post-commit
- 8. No Ticket, No Commit In the future, when you look back to the code, you want to know why this guy changed this code ? Such as: “Fixed rspec error” “Refactored the code” ---- > “GI-12345: Fixed rspec error” “GI-54321: Refactored the code”
- 9. Pre-commit -1 Before commit, this hook can check something for you. For example, in my pc, I will check where the code has “binding.pry” or not. Place: .git/hooks/pre-commit Code: #!/usr/bin/env ruby require 'colorize' # check for rails debugger rails_result = `grep -rlsn "binding.pry" --exclude-dir=".git" .` if rails_result != "" puts "[Error] you put binding.pry in your filesn".red puts rails_result exit(1) end
- 10. Pre-commit -2
- 11. Prepare-commit-msg -1 • Means giving commit-msg a template For example: Now you are working at pr-GI-12345-2.5-id Every time, when you commit, you want to add ticket number to your commit message. commit message here ↓ Ticket #GI-12345 commit message here.
- 12. Prepare-commit-msg -2 • #!/usr/bin/env ruby • • TICKET_REGEXP = /[A-Z]+-d+/ # WEB-12345 • • TICKET_REF_FORMAT = 'Ticket #%s # ' # JIRA Ticket reference syntax. • • branch_name = `git branch --no-color 2> /dev/null`[/^* (.+)/, 1] • msg_filename = ARGV[0] • • if ticket_in_branch = branch_name.match(TICKET_REGEXP) • ticket_ref = TICKET_REF_FORMAT % ticket_in_branch.to_s • old_msg = File.read msg_filename • • unless old_msg.match ticket_ref • File.open msg_filename, 'w' do |new_msg| • new_msg.write ticket_ref + old_msg • end • end • end • • exit 0
- 14. Commit-msg -1 • We can this hook to check whether your commit message has ticket number or not. • #!/usr/bin/env ruby • • require 'colorize' • • TICKET_REGEXP = /[A-Z]+-d+/ # WEB-12345 • • commit_message = File.open ARGV[0], 'r' { |f| f.read } • • unless commit_message.match(TICKET_REGEXP) • puts "[ERROR] commit-message-format: JIRA ticket number is not existed.".red • exit(1) • end
- 15. Commit-msg -2
- 16. Post-commit -1 If everything goes well, then we can open firefox to log your time. • #!/usr/bin/env ruby • • require 'colorize' • • TICKET_REGEXP = /[A-Z]+-d+/ # WEB-12345 • • LINK = "https://*****.atlassian.net/browse/" • • puts "[Warning] log time: Please do not forget to log your time".red • • commit_message = %x{git log -1 --abbrev-commit}.split("n").last.strip • • jira_ticket = commit_message.match(TICKET_REGEXP) • puts "please visit #{LINK}#{jira_ticket.to_s} to log time".green • • exec("firefox #{LINK}#{jira_ticket.to_s}")
- 17. Post-commit -2
- 18. Server side (git push) • pre-receive • update • post-receive